POST
/
v1
/
accounts
/
contacts
/
filter
/
ids
Filter customer contacts by IDs
curl --request POST \
  --url https://platform.thena.ai/v1/accounts/contacts/filter/ids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "ids": [
    "C123",
    "C456"
  ]
}'
[
  {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "avatarUrl": "<string>",
    "accounts": [
      "<string>"
    ],
    "contactTypeId": "<string>",
    "contactType": "<string>",
    "customFieldValues": [
      "<string>"
    ],
    "metadata": {},
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

Enter your API key

Body

application/json

Contact IDs to filter

​
ids
string[]
required

The IDs of the customer contacts to filter

Example:
["C123", "C456"]

Response

Customer contacts filtered successfully

​
id
string
required

The identifier of the customer contact

​
firstName
string
required

The first name of the customer contact

​
lastName
string
required

The last name of the customer contact

​
email
string
required

The email of the customer contact

​
phoneNumber
string
required

The phone number of the customer contact

​
avatarUrl
string
required

The avatar URL of the customer contact

​
accounts
string[]
required

The name of the account

​
contactTypeId
string
required

The identifier of the contact type

​
contactType
string
required

The name of the contact type

​
customFieldValues
string[]
required

The custom field values

​
metadata
object
required

The metadata of the contact

​
createdAt
string
required

The creation date of the contact

​
updatedAt
string
required

The last update date of the contact