Contacts

Get a list of contacts

'This method requires the Contacts:Get permission to be associated with your role.'

GET

/fm/contacts

curl --request GET \
  --url 'https://api.catch-e.com/fm/contacts?table_name=fm_clients&record_id=%3Cstring%3E&include_inactive_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "contacts": [
      {
        "_links": {
          "job_title": {
            "href": "https://api.catch-e.com/fm/contact/job-titles/1234567890123456789"
          },
          "self": {
            "href": "https://api.catch-e.com/fm/contact/1234567890123456789"
          }
        },
        "address1": "Level 1 ",
        "address2": "111 Street name",
        "allocations": [
          {
            "contact_id": "1234567890123456789",
            "record_id": "100001",
            "status_flag": "active",
            "table_name": "fm_clients"
          }
        ],
        "area": "",
        "contact_id": "1234567890123456789",
        "contact_job_title_id": "1234567890123456789",
        "contact_type_allocations": [
          {
            "contact_id": "1234567890123456789",
            "contact_type_id": "1234567890123456789",
            "email_type": "to"
          }
        ],
        "country_id": "12312312312312312312",
        "email": "hello@catch-e.com.au",
        "given_name": "Abc",
        "mobile": "+61423456789",
        "note": "Any note in relation to the contact",
        "phone": "+61391234567",
        "postcode": "3173",
        "salutation": "Mrs",
        "state_id": "100000",
        "status_flag": "active",
        "surname": "Def"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/contacts/?table_name=fm_clients&record_id=100001&include_inactive_flag=no&page=1&page_size=25"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

table_nameenum<string>queryrequired

Table name

Available options: fm_clients, fm_client_groups, fm_client_cost_centres, fm_client_divisions

record_idstringqueryrequired

Record id in the linked table

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive contacts required in the list. Note 'deleted' records cannot be returned.

Available options: yes, no

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team