API Documentation
Endpoint Examples
Phone Numbers
Campaigns
Webhooks
Get All Contacts
Returns all contacts associated with the authenticated user’s company
curl --request GET \
--url http://sandbox.mintlify.com/contact \
--header 'Authorization: Bearer <token>'{
"status": "ok",
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstname": "<string>",
"lastname": "<string>",
"phone_number": "<string>",
"metadata": {},
"number_country_code": "<string>",
"last_call_status": "<string>",
"last_call_at": "2023-11-07T05:31:56Z",
"last_call_duration": 123,
"last_call_feedback": "<string>",
"source_name": "<string>",
"tag_name": "<string>",
"category_name": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The maximum number of results to return
Response
ok, error The first name of the contact
The last name of the contact
The phone number of the contact
The unique identifier for the contact
The unique identifier for the company associated with the contact
Additional metadata associated with the contact
The country code for the phone number
The status of the last call made to the contact
The timestamp of the last call made to the contact
The duration of the last call in seconds
Feedback from the last call
The source of the contact
The tag associated with the contact
The category associated with the contact
Additional notes or description for the contact
Timestamp when the contact was created
Timestamp when the contact was last updated
The unique identifier for the campaign associated with the contact
The current status of the contact
Was this page helpful?
curl --request GET \
--url http://sandbox.mintlify.com/contact \
--header 'Authorization: Bearer <token>'{
"status": "ok",
"message": "<string>",
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstname": "<string>",
"lastname": "<string>",
"phone_number": "<string>",
"metadata": {},
"number_country_code": "<string>",
"last_call_status": "<string>",
"last_call_at": "2023-11-07T05:31:56Z",
"last_call_duration": 123,
"last_call_feedback": "<string>",
"source_name": "<string>",
"tag_name": "<string>",
"category_name": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}
]
}