Get all contacts
GET
https://api.expirationreminder.net/v1/contactsQuery Parameters
term
stringOptionalDefault:
email
stringOptionalDefault:
page
integerOptionalDefault: -1
sort
stringOptionalDefault:
sortDirection
stringOptionalDefault: asc
GET /v1/contacts
$ curl https://api.expirationreminder.net/v1/contacts \
-H "Authorization: Bearer <token>"
Responses
| Property | Type | Description |
|---|---|---|
contacts |
object[] |
- |
pages |
integer (int32) |
- |
page |
integer (int32) |
- |
total |
integer (int32) |
- |
Example Response
{
"contacts": [
{
"name": "string",
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"timezone": "string",
"mobile": "string",
"phone": "string",
"assigned_to": {
"name": "string",
"email": "string",
"id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000"
},
"type_id": "00000000-0000-0000-0000-000000000000",
"contact_id": "string",
"location_id": "00000000-0000-0000-0000-000000000000",
"team_id": "00000000-0000-0000-0000-000000000000",
"is_active": false,
"modified": "string",
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"value": "string"
}
]
}
],
"pages": 0,
"page": 0,
"total": 0
}Bad Request
| Property | Type | Description |
|---|---|---|
message |
string |
- |
ok |
boolean |
- |
Example Response
{
"message": "string",
"ok": false
}