Scope: contacts:contacts.read https://api.alladdin.com/api/v2/contact-groups/{contactGroupId}

Returns a single contact group by its ID.

Parameters

Path parameters

contactGroupId string required

Contact Group ID (24-char hex ObjectId)

Request

import requests

url = "https://api.alladdin.com/api/v2/contact-groups/{contactGroupId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "string",
  "description": "string",
  "color": "string"
}

Success responses

200 Contact group found application/json object id string required

Unique identifier

name string required

Group name

description string required

Group description

color string required

Group color

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Contact group not found application/json 429 Rate limit exceeded application/json

← PreviousList contact groups →

Next →Delete a contact group →