Contact / Type Allocations

Get a list of contact type allocations

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

GET

/fm/contact/type/allocations

curl --request GET \
  --url 'https://api.catch-e.com/fm/contact/type/allocations?contact_id=%3Cstring%3E&contact_type_id=%3Cstring%3E&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

[
  {
    "_links": {
      "contact": {
        "href": "https://api.catch-e.com/fm/contacts/1234567890123456789"
      },
      "contact_type": {
        "href": "https://api.catch-e.com/fm/contact/types/1234567890123456789"
      }
    },
    "contact_id": "1234567890123456789",
    "contact_type_id": "1234567890123456789",
    "email_type": "to"
  }
]

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

contact_idstringqueryrequired

Contact Id

Maximum string length: 20

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

contact_type_idstringquery

Optional contact type Id

Maximum string length: 20

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

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

itemsobject[]

Show child attributes

Still need help? Ask the team