List contacts
This call will return a list of contacts for the current authenticated entity.
Contacts are used only as a lookup reference when adding recipients to a new document.
Request
- Base URL: https://api.getaccept.com
- URL: https://api.getaccept.com/v1/contacts
- Auth: HTTP bearer
Query parameters
Contact status: active for a contact that is a recipient of at least one document or is in a deal room, inactive for one that is neither, and signed for one that has signed at least one document.
Filter the list on status.
Field contacts are sorted by: name sorts on first name, email on email address, company_name on company name, document_count on the number of documents the contact is a recipient of, and created on when the contact was created.
How to sort the results. Without it, or with an unknown value, contacts are sorted on first name, descending, and sort_order is ignored.
Sort direction: ASC for ascending or DESC for descending.
Sort order when sort_by is set, case-insensitive. Defaults to ASC.
Include contacts from team members. Any non-empty value other than 0 turns it on, including false.
Include all contacts from the entity. Any non-empty value other than 0 turns it on, including false. Ignored when the entity restricts data visibility and the authenticated user has the user role.
Start the list from record x until limit. Defaults to 0.
Number of records to list. Defaults to 100.
Return only contacts whose first name, last name, email, company name or mobile number contains this text, ignoring case. The text is matched against these fields joined with spaces, so John Doe matches a contact named John Doe.
Response
The request succeeded.
Changes
No recorded changes to this operation across all 1 revision of this API.