Get All Contacts

Retrieves a paginated list of all contacts with optional filtering, searching, and ordering.

HTTP Request

GET/api/contacts

Authorization

Authorization

• Required: Yes
• Permission: Staff or Admin
• Authentication: Token-based (Authorization: Token <your_api_key>)

Query Parameters

Parameter	Type	Default	Description
limit	integer	—	Number of results to return per page.
offset	integer	—	Number of results to skip before returning results.
search	string	—	Search term to filter results by `id`, `subject`, `first_name`, `last_name`, `email`, and `mobile_number`.
ordering	string	—	Field to order results by (`id`, `created_at`, `updated_at`, `viewed`, `viewed_at`, `subject`)
is_viewed	boolean	—	Filter by viewed status (`true` for viewed, `false` for not viewed).
viewed_date	string	—	Exact viewed date (`YYYY-MM-DD`).
viewed_date_from	string	—	Start date for contacts viewed after this date (`YYYY-MM-DD`).
viewed_date_to	string	—	End date for contacts viewed before this date (`YYYY-MM-DD`).
has_message	boolean	—	Filter by contacts that have a message (`true` for contacts with a message, `false` for those without).
has_mobile_number	boolean	—	Filter by contacts that have a mobile number (`true` for contacts with a mobile number, `false` for those without).
has_email	boolean	—	Filter by contacts that have an email address (`true` for contacts with an email, `false` for those without).
has_first_name	boolean	—	Filter by contacts that have a first name (`true` for contacts with a first name, `false` for those without).
has_last_name	boolean	—	Filter by contacts that have a last name (`true` for contacts with a last name, `false` for those without).
id_min	integer	—	Minimum ID of the contact.
id_max	integer	—	Maximum ID of the contact.
created_date	string	—	Exact creation date (`YYYY-MM-DD`).
updated_date	string	—	Exact last update date (`YYYY-MM-DD`).
created_from	string	—	Start date for contacts created after this date (`YYYY-MM-DD`).
updated_from	string	—	Start date for contacts updated after this date (`YYYY-MM-DD`).
created_to	string	—	End date for contacts created before this date (`YYYY-MM-DD`).
updated_to	string	—	End date for contacts updated before this date (`YYYY-MM-DD`).

Example Requests

🐍 Python

1import requests
2
3# List all contacts
4response = requests.get('http://www.example.com/api/contacts/',
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

🌐 Curl

1# List all contacts
2curl "http://www.example.com/api/contacts/" -H "Authorization: Token <your_api_key>"

Status Codes

Code	Description
200	Contacts retrieved successfully
400	Bad request — invalid parameters
401	Unauthorized — authentication required
403	Forbidden — insufficient permissions
500	Internal server error

Response Fields

Field	Type	Description
id	Integer	Unique ID of the contact.
subject	String	The subject of the contact.
message	String	The message content of the contact.
first_name	String	The first name of the contact.
last_name	String	The last name of the contact.
email	String	The email address of the contact.
mobile_number	String	Mobile number associated with the contact.
viewed	Boolean	Whether the contact has been viewed.
viewed_at	String (ISO 8601)	Timestamp when the contact was viewed.
created_at	String (ISO 8601)	Timestamp when the contact was created.
updated_at	String (ISO 8601)	Timestamp when the contact was last updated.