v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Contact Endpoints

contacts

This endpoint is used to get a list of contacts associated with the account.

get/contacts

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ContactIDstring

The ID of the contact to retrieve. If this is not provided, all contacts will be returned.

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

SearchTextstring

A text string to search for in the email addresses, names and business number.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Contacts": {
    "0": {
      "ContactName": "Test Contact",
      "EmailAddress": "test@contact.com",
      "PhoneNumber": "7781111111",
      "IsActive": "1",
      "Nationality": "Canada",
      "Currency": "CAD"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}