Skip to main content
GET
/
campaign-groups
/
{campaignGroupId}
Get a campaign group by id
curl --request GET \
  --url https://api.callers.ai/campaign-groups/{campaignGroupId} \
  --header 'Authorization: <api-key>'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Onboarding Campaigns",
  "organizationId": "507f1f77bcf86cd799439012",
  "campaignsCount": 3,
  "createdAt": "2024-04-09T12:00:00.000Z",
  "updatedAt": "2024-04-09T13:30:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

​
campaignGroupId
string
required

Id of the campaign group as a string ObjectId value.

Response

​
id
string
required

Unique identifier for the campaign group. String representation of an ObjectId.

Example:

"507f1f77bcf86cd799439011"

​
name
string
required

Display name of the campaign group.

Example:

"Onboarding Campaigns"

​
organizationId
string
required

Id of the organization this campaign group belongs to. String representation of an ObjectId.

Example:

"507f1f77bcf86cd799439012"

​
campaignsCount
number
required

Number of campaigns currently assigned to this campaign group.

Example:

3

​
createdAt
string<date-time> | null
required

Timestamp when the campaign group was created (ISO 8601 string).

Example:

"2024-04-09T12:00:00.000Z"

​
updatedAt
string<date-time> | null
required

Timestamp when the campaign group was last updated (ISO 8601 string).

Example:

"2024-04-09T13:30:00.000Z"