Contacts
Get Contacts
Retrieve a list of contacts for the authenticated user, each containing details such as the contact ID, nickname, contact type, and timestamps.
- This endpoint allows searching for contacts by nickname or other attributes.
- The results can be paginated using the limit and offset parameters.
get/contacts
Request
- Base URLhttps://openapi.n3xt.io
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
searchStringstring
Optional search string to filter contacts by nickname or other attributes.
limitnumber double
Positive integer page size. 0 is rejected.
offsetnumber double
Non-negative integer page offset. Default: 0.
orderBy'createdAt' | 'updatedAt'
Optional field to sort contacts by. Available fields: createdAt, updatdAt.
order'asc' | 'desc'
Optional direction to sort contacts by.
Response
A list of contacts was retrieved successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.