Contacts
List contacts
Returns a paginated list of contacts scoped to your company. All filter params are optional and ANDed together.
get/api/contacts
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger required
Zero-based page index.
contact_typestring
Filter by contact type name.
emailstring
Filter by exact email address (case-insensitive).
phonestring
Filter by phone number (digits only, partial match).
namestring
Filter by full name (case-insensitive, all words must match).
updated_afterstring date-time
Return only contacts updated after this ISO 8601 timestamp.
updated_beforestring date-time
Return only contacts updated before this ISO 8601 timestamp.
Response
Paginated contact list.
Changes
No recorded changes to this operation across all 1 revision of this API.