ReferencesOpenapiContact
List contacts
List contacts in the specified organisation and workspace, including contact methods and addresses, with optional search and pagination.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication
In: header
Path Parameters
orgId*string
workspaceId*string
Query Parameters
search?string
page?number
Range
1 <= valueDefault
1limit?number
Range
1 <= value <= 50Default
10Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/organisation/string/workspace/string/contact"{ "items": [ { "id": -2147483648, "version": -2147483648, "createdAt": "string", "createdBy": "string", "deletedAt": "string", "lastUpdatedAt": "string", "lastUpdatedBy": "string", "type": "string", "status": "string", "firstName": "string", "lastName": "string", "middleNames": "string", "preferredName": "string", "title": "string", "dateOfBirth": "string", "relationshipStatus": "string", "numberOfDependents": -2147483648, "residencyStatus": "string", "referenceId": "string", "preferredContactMethods": [ "string" ], "description": "string", "externalReference": "string", "metadata": "string", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "employerId": -2147483648, "workspaceId": -2147483648, "organisationId": -2147483648, "fullNameSearch": "string", "contactMethods": [ { "id": -2147483648, "type": "string", "value": "string", "contactId": -2147483648 } ], "addresses": [ { "id": -2147483648, "deletedAt": "string", "lastUpdatedAt": "string", "lastUpdatedBy": "string", "type": "string", "addressLine1": "string", "addressLine2": "string", "unitNumber": "string", "streetNumber": "string", "streetName": "string", "state": "string", "suburb": "string", "city": "string", "postCode": "string", "country": "string", "contactId": -2147483648 } ] } ], "pagination": { "total": 0, "page": 0, "limit": 0, "totalPages": 0 }}