🐙 Intro
Welcome to the documentation for the contacts feature of our API. This feature allows you to access consumer contacts and perform opertions such as adding, updating and filtering contacts. To ensure security and proper authorization, all endpoints require authentication through an API key. You can obtain the API key by contacting our support team.
🔒 Authentication
To access any of the contacts feature endpoint, you must provide a valid API key in all your requets.
To know more about out authentication methods you can access the Authentication document.
🌐 Endpoints
- POST /contacts: Add a new contact to the list of consumer contacts;
- GET /contacts: Retrieve all contacts or apply filters and pagination to retrive specific contacts;
- GET /contacts/{id}: Retrieve a specific contact based on the ID;
- PUT /contacts/{id}: Update all information about a contact based on its ID;
- PATCH /contacts/{id}: Update some information about a contact based on its ID.
📔 Filters, Pagination and Sorting
To filter contacts you can use the GET /contacts endpoint with the filters based on specific search criteria and use the pagination and sort to organize your result as you wish.
📗 Available Filters
| Property | Format | Description |
|---|---|---|
| name | string | Name of the contact |
| string | Email of the contact | |
| organization.id | string | Organization Identifier |
| organizartion.name | string | Organization Name |
| organization.domain | string | Domains belonging to the Organization |
| phoneContacts.number | string | Contact Phone Number |
| responsible.name | string | Name of person responsible for contact |
| responsible.email | string | Email of person responsible for contact |
To know more about how to use these filtering and organization tools look at these documents:
You can use the sorting (sort), pagination (page and limit), and filtering (filters) features together to tailor your API queries and retrieve precisely the data you need.