Group of contacts.

Can contain both user and non-user contacts in one group. Allows sending email and text messages (sms).

Query parameters

name: Text filter on name. Supports various lookup types (name__exact by default).

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.

Examples

?name=Example

?name__icontains=Examp

?name__icontains=Examp&page_size=100

?organisation__unique_id=c5e37ca3495045168f5d911c37ee2319
GET /api/v3/contactgroups/
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}