List contact groups
Scope: contacts:contacts.read https://api.alladdin.com/api/v2/contact-groups
Returns a paginated list of contact groups.
Results are cursor-paginated: the response includes a cursor value and a has_more boolean. Pass the cursor to the next request to fetch the following page.
Parameters
Query parameters
cursor string optional
Pagination cursor returned by the previous response. Omit to start from the first page.
limit integer optional = 50
Maximum number of items to return
Request
import requests
url = "https://api.alladdin.com/api/v2/contact-groups?cursor=value&limit=50"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"name": "string",
"description": "string",
"color": "string"
}
],
"cursor": "string",
"has_more": false
}Success responses
200 List of contact groups application/json object items[] object[] required id string required
Unique identifier
name string required
Group name
description string required
Group description
color string required
Group color
cursor string | null optional has_more boolean required
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json