Skip to main content
GET
Get Contacts

List Contacts

This endpoint allows you to retrieve a list of contacts for a company with optional filtering and pagination.

Headers

Query Parameters

Parameter Examples

  • Basic request: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456
  • With pagination: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&skip=0&limit=10
  • With search: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&search=john
  • With sorting: GET /contacts?company_id=64b8f1a2e4b0c8d9f0123456&sort=created_at&order=desc

Response

Response Parameters

Contact Object Fields

Error Responses

Invalid Request (400)

Unauthorized (401)

Company Not Found (404)

Internal Server Error (500)

Authorizations

X-API-Key
string
header
required

Formation API key for authentication.

Query Parameters

company_id
string
required

Company ID

skip
string

Number of records to skip

limit
string

Number of records to return

Search term

sort
string

Sort field

order
enum<string>

Sort order (asc/desc)

Available options:
asc,
desc
created_at
string

Created at filter

created_at_value
string

Created at value

end_date
string

End date filter

Response

Contacts retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Contacts retrieved successfully"

data
object