Contact List
Contact info.
Query parameters
first_name:
Text filter on first name
. Supports various lookup types
(first_name__exact by default).
last_name:
Text filter on last name
. Supports various lookup types
(last_name__exact by default).
email:
Text filter on email
. Filters on iexact email.
phone_number:
Text filter on phone_number
. Filters on iexact phone number.
created:
Temporal filter on created
. Supports various lookup types
(exact
, lt
, lte
, gt
, gte
; created__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
last_modified:
Temporal filter on last_modified
. Supports various lookup types
(exact
, lt
, lte
, gt
, gte
; last_modified__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
organisation:
Related filter on organisation
. See the
organisations endpoint.
page_size: The maximum number of results to return in list-view. The default is 10.
ordering
Show the results in a specific order.
You can order them by id
, first_name
, last_name
, email
and organisation__name
.
Add a -
in front to reverse the order.
Examples
?first_name=Example
?last_name__icontains=Examp
?last_name__icontains=Examp&page_size=100
?created__gte=2017-01-01T00:00:00Z
?last_modified__lt=2018-01-01T00:00:00Z
?organisation__uuid=c5e37ca3495045168f5d911c37ee2319
?organisation__name__icontains=Nel
?ordering=-organisation__name
GET /api/v4/contacts/?format=api
{
"count": 0,
"next": null,
"previous": null,
"results": []
}