List all contacts by category
GET
/contacts/categories/{category_id}/contactsLists all the contacts contained within a specific contact category.
Request
Path Params
category_id
integer
required
Contact category ID.
Example:
3
Query Params
page
integer
optional
The page of results to view.
Example:
1
limit
integer
optional
The amount of results per page.
Example:
5
Responses
OK(200)
Contact Category doesn't exists(410)
Unprocessable Entity(422)
Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
current_page
integer
required
data
array [object {65}]
required
first_name
string
required
last_name
string
required
label
string
required
website
null
optional
phone_number
string
required
email
string
required
birthdate
string
required
country
string
required
street
string
required
street2
string
required
city
string
required
state
string
required
zip
string
required
f252
array[string]
required
driver_license
string
required
f256
string
required
id
integer
required
created_at
string
required
updated_at
string
required
entity
string
required
gender
null
required
birthdate_day
integer
required
birthdate_month
integer
required
birthdate_year
integer
required
birthplace
null
optional
nationality
null
optional
last_rental
null
optional
county
null
optional
uuid
string
required
created_by
integer
required
updated_by
integer
required
deleted_at
null
optional
phone_alternative
null
optional
email_alternative
null
optional
housenumber
null
optional
suburb
null
optional
identification
null
optional
phone_cc
null
optional
phone_country
null
optional
accounting_list_id
null
optional
accounting_edit_sequence
null
optional
password
null
optional
reset_password_token
null
optional
expiration_date_for_password_reset_token
null
optional
phone_ext
null
optional
f193
null
optional
f194
null
optional
f195
null
optional
f196
null
optional
f198
null
optional
invoices_currency
null
optional
invoices_open_balance
null
optional
invoices_overdue_balance
null
optional
car_rental_reservation_count
integer
required
external_contact_type
null
optional
external_contact_id
null
optional
car_rental_balance
string | null
required
expiration_notification_sent
integer
required
f254
null
optional
from_public_form
boolean
required
verified
boolean
required
language
string
required
invoices_last_reminder_sent_at
null
optional
id_verification_id
null
optional
pivot
object
required
first_page_url
string
required
from
integer
required
last_page
integer
required
last_page_url
string
required
next_page_url
string
required
path
string
required
per_page
integer
required
prev_page_url
null
optional
to
integer
required
total
integer
required
Exampleresponse
{
"current_page": 1,
"data": [
{
"first_name": "Isabell",
"last_name": "Predovic",
"label": "Isabell Predovic",
"website": null,
"phone_number": "564.423.3865",
"email": "schulist.abdul@hotmail.com",
"birthdate": "1994-08-09",
"country": "gp",
"street": "1390 Alverta Inlet",
"street2": "Apt. 395",
"city": "Port Garland",
"state": "Maine",
"zip": "18694",
"f252": [],
"driver_license": "388386",
"f256": "2025-06-05 00:00:00",
"id": 60,
"created_at": "2024-08-09T00:20:55.000000Z",
"updated_at": "2024-08-13T18:57:04.000000Z",
"entity": "person",
"gender": null,
"birthdate_day": 9,
"birthdate_month": 8,
"birthdate_year": 1994,
"birthplace": null,
"nationality": null,
"last_rental": null,
"county": null,
"uuid": "xgsx7uaz-29up-g4yh-se45-xw5epapglqwy",
"created_by": 1,
"updated_by": 84,
"deleted_at": null,
"phone_alternative": null,
"email_alternative": null,
"housenumber": null,
"suburb": null,
"identification": null,
"phone_cc": null,
"phone_country": null,
"accounting_list_id": null,
"accounting_edit_sequence": null,
"password": null,
"reset_password_token": null,
"expiration_date_for_password_reset_token": null,
"phone_ext": null,
"f193": null,
"f194": null,
"f195": null,
"f196": null,
"f198": null,
"invoices_currency": null,
"invoices_open_balance": null,
"invoices_overdue_balance": null,
"car_rental_reservation_count": 1,
"external_contact_type": null,
"external_contact_id": null,
"car_rental_balance": "2106.00",
"expiration_notification_sent": 0,
"f254": null,
"from_public_form": false,
"verified": true,
"language": "en",
"invoices_last_reminder_sent_at": null,
"id_verification_id": null,
"pivot": {
"category_id": 3,
"contact_id": 60,
"deleted_at": null
}
},
{
"first_name": "Annabel",
"last_name": "Deckow",
"label": "Annabel Deckow",
"website": null,
"phone_number": "+19704747369",
"email": "coralie95@hotmail.com",
"birthdate": "1994-08-09",
"country": "fm",
"street": "196 Otilia Junction Apt. 174",
"street2": "Suite 710",
"city": "Sipestown",
"state": "North Carolina",
"zip": "24609",
"f252": [],
"driver_license": "936031357",
"f256": "2024-09-25 00:00:00",
"id": 59,
"created_at": "2024-08-09T00:20:55.000000Z",
"updated_at": "2024-08-09T00:20:55.000000Z",
"entity": "person",
"gender": null,
"birthdate_day": 9,
"birthdate_month": 8,
"birthdate_year": 1994,
"birthplace": null,
"nationality": null,
"last_rental": null,
"county": null,
"uuid": "jllui7ml-smhw-ikfi-pfr2-61lpzdox438a",
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"phone_alternative": null,
"email_alternative": null,
"housenumber": null,
"suburb": null,
"identification": null,
"phone_cc": null,
"phone_country": null,
"accounting_list_id": null,
"accounting_edit_sequence": null,
"password": null,
"reset_password_token": null,
"expiration_date_for_password_reset_token": null,
"phone_ext": null,
"f193": null,
"f194": null,
"f195": null,
"f196": null,
"f198": null,
"invoices_currency": null,
"invoices_open_balance": null,
"invoices_overdue_balance": null,
"car_rental_reservation_count": 1,
"external_contact_type": null,
"external_contact_id": null,
"car_rental_balance": null,
"expiration_notification_sent": 0,
"f254": null,
"from_public_form": false,
"verified": true,
"language": "en",
"invoices_last_reminder_sent_at": null,
"id_verification_id": null,
"pivot": {
"category_id": 3,
"contact_id": 59,
"deleted_at": null
}
},
{
"first_name": "Darren",
"last_name": "Hagenes",
"label": "Darren Hagenes",
"website": null,
"phone_number": "1-904-771-3343",
"email": "leuschke.sincere@armstrong.biz",
"birthdate": "1994-08-09",
"country": "pm",
"street": "11619 Carson Canyon Apt. 499",
"street2": "Suite 655",
"city": "Jonesberg",
"state": "Connecticut",
"zip": "93358-4026",
"f252": [],
"driver_license": "470",
"f256": "2025-07-08 00:00:00",
"id": 58,
"created_at": "2024-08-09T00:20:54.000000Z",
"updated_at": "2024-08-09T00:20:54.000000Z",
"entity": "person",
"gender": null,
"birthdate_day": 9,
"birthdate_month": 8,
"birthdate_year": 1994,
"birthplace": null,
"nationality": null,
"last_rental": null,
"county": null,
"uuid": "84dcmu82-wkim-7wbp-lzgr-lxrcfur7ueyv",
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"phone_alternative": null,
"email_alternative": null,
"housenumber": null,
"suburb": null,
"identification": null,
"phone_cc": null,
"phone_country": null,
"accounting_list_id": null,
"accounting_edit_sequence": null,
"password": null,
"reset_password_token": null,
"expiration_date_for_password_reset_token": null,
"phone_ext": null,
"f193": null,
"f194": null,
"f195": null,
"f196": null,
"f198": null,
"invoices_currency": null,
"invoices_open_balance": null,
"invoices_overdue_balance": null,
"car_rental_reservation_count": 1,
"external_contact_type": null,
"external_contact_id": null,
"car_rental_balance": null,
"expiration_notification_sent": 0,
"f254": null,
"from_public_form": false,
"verified": true,
"language": "en",
"invoices_last_reminder_sent_at": null,
"id_verification_id": null,
"pivot": {
"category_id": 3,
"contact_id": 58,
"deleted_at": null
}
},
{
"first_name": "Charley",
"last_name": "Sanford",
"label": "Charley Sanford",
"website": null,
"phone_number": "+1 (360) 496-3496",
"email": "tharvey@kub.com",
"birthdate": "1994-08-09",
"country": "ni",
"street": "7269 Hyatt Skyway",
"street2": "Apt. 813",
"city": "Port Kamille",
"state": "Rhode Island",
"zip": "71131-5674",
"f252": [],
"driver_license": "900564269",
"f256": "2024-11-11 00:00:00",
"id": 57,
"created_at": "2024-08-09T00:20:54.000000Z",
"updated_at": "2024-08-09T00:20:54.000000Z",
"entity": "person",
"gender": null,
"birthdate_day": 9,
"birthdate_month": 8,
"birthdate_year": 1994,
"birthplace": null,
"nationality": null,
"last_rental": null,
"county": null,
"uuid": "bkbshdsd-ratt-sfgy-zy0o-hsmiymnbtkns",
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"phone_alternative": null,
"email_alternative": null,
"housenumber": null,
"suburb": null,
"identification": null,
"phone_cc": null,
"phone_country": null,
"accounting_list_id": null,
"accounting_edit_sequence": null,
"password": null,
"reset_password_token": null,
"expiration_date_for_password_reset_token": null,
"phone_ext": null,
"f193": null,
"f194": null,
"f195": null,
"f196": null,
"f198": null,
"invoices_currency": null,
"invoices_open_balance": null,
"invoices_overdue_balance": null,
"car_rental_reservation_count": 1,
"external_contact_type": null,
"external_contact_id": null,
"car_rental_balance": null,
"expiration_notification_sent": 0,
"f254": null,
"from_public_form": false,
"verified": true,
"language": "en",
"invoices_last_reminder_sent_at": null,
"id_verification_id": null,
"pivot": {
"category_id": 3,
"contact_id": 57,
"deleted_at": null
}
},
{
"first_name": "Breanne",
"last_name": "Schiller",
"label": "Breanne Schiller",
"website": null,
"phone_number": "(650) 522-8834",
"email": "aliza65@gmail.com",
"birthdate": "1994-08-09",
"country": "cy",
"street": "971 Eula Route Apt. 453",
"street2": "Suite 230",
"city": "Wuckertborough",
"state": "Massachusetts",
"zip": "51168-4483",
"f252": [],
"driver_license": "61801461",
"f256": "2024-09-28 00:00:00",
"id": 56,
"created_at": "2024-08-09T00:20:54.000000Z",
"updated_at": "2024-08-09T00:20:54.000000Z",
"entity": "person",
"gender": null,
"birthdate_day": 9,
"birthdate_month": 8,
"birthdate_year": 1994,
"birthplace": null,
"nationality": null,
"last_rental": null,
"county": null,
"uuid": "88gltpyp-3egm-vj1d-gqxs-1kuoxqr3dulo",
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"phone_alternative": null,
"email_alternative": null,
"housenumber": null,
"suburb": null,
"identification": null,
"phone_cc": null,
"phone_country": null,
"accounting_list_id": null,
"accounting_edit_sequence": null,
"password": null,
"reset_password_token": null,
"expiration_date_for_password_reset_token": null,
"phone_ext": null,
"f193": null,
"f194": null,
"f195": null,
"f196": null,
"f198": null,
"invoices_currency": null,
"invoices_open_balance": null,
"invoices_overdue_balance": null,
"car_rental_reservation_count": 1,
"external_contact_type": null,
"external_contact_id": null,
"car_rental_balance": null,
"expiration_notification_sent": 0,
"f254": null,
"from_public_form": false,
"verified": true,
"language": "en",
"invoices_last_reminder_sent_at": null,
"id_verification_id": null,
"pivot": {
"category_id": 3,
"contact_id": 56,
"deleted_at": null
}
}
],
"first_page_url": "",
"from": 1,
"last_page": 12,
"last_page_url": "",
"next_page_url": "",
"path": "",
"per_page": "5",
"prev_page_url": null,
"to": 5,
"total": 60
}
Last modified: 3 months ago