GET
/
contact
curl --request GET \
  --url https://api.thoughtly.com/contact \
  --header 'team_id: <api-key>' \
  --header 'x-api-token: <api-key>'
{
  "error": {},
  "data": {}
}

Authorizations

​
x-api-token
string
header
required

API key for the user making the request. This can be found via the Developer Settings page in the dashboard.

​
team_id
string
header
required

Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.

Query Parameters

​
search
string

Search term to filter contacts by name, phone number, or other attributes.

​
phone_numbers_only
boolean

Filter results to show only contacts with phone numbers.

​
tags
string[]

Filter results by tags associated with the contacts. You can specify multiple tags.

​
excluded_tags
string[]

Exclude contacts that have these tags.

​
sort
string

Sort the contacts based on a specific field, such as name or creation date.

​
sortDirection
enum<string>

Specify the sort direction. Choose either ascending ('asc') or descending ('desc').

Available options:
asc,
desc
​
page
integer

Specify the page of results to retrieve (pagination).

Required range: x >= 0
​
limit
integer
default:20

Specify the maximum number of contacts to return per page (pagination). The default is 20.

Required range: 1 <= x <= 50

Response

200 - application/json

Successful response

The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.