Entities/Contacts
List contacts
Returns a paginated list of general contacts with optional filtering and sorting.
AuthorizationBearer <token>
In: header
Query Parameters
sort?string
Sort field. Prefix with - for descending.
limit?integer
Items per page. Default 50, maximum 250; a larger value is truncated to 250.
Default
50Range
1 <= value <= 250page?integer
Page number. Default 1; a value below 1 counts as 1.
Default
1Range
1 <= valuefilter[name]?string
Filter by contact name.
filter[email]?string
Filter by email address.
filter[country]?string
Filter by country code.
filter[taxid]?string
Filter by tax ID.
Response Body
curl -X GET "https://og-tenant1.test:8003/api/v2/entities/contacts?sort=string&limit=50&page=1&filter%5Bname%5D=string&filter%5Bemail%5D=string&filter%5Bcountry%5D=string&filter%5Btaxid%5D=string"{
"data": [
{
"id": 1,
"name": "Joao Silva",
"address": "Rua das Flores 123",
"city": "Lisboa",
"zipcode": "1000-001",
"country": "PT",
"phone1": "+351.912345678",
"phone2": "+351.912345679",
"mobilephone": "+351.961234567",
"email": "joao@exemplo.pt",
"email2": "string",
"email3": "string",
"taxid": "123456789",
"profession_id": "1",
"rgdp_allow_mailing": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {
"per_page": 50,
"current_page": 1,
"has_more": true
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}