Groups Reference

Endpoints for managing audience segments and associating contact memberships.

GET

/api/v1/groups

Returns audience groups with live contact counts.

Code Example (5 Languages)

curl "https://app.pingstack.in/api/v1/groups" \
  -H "Authorization: Bearer ps_secret_live_YOUR_API_KEY"

Response Example

JSON
{
  "success": true,
  "data": [
    {
      "id": "g1...",
      "name": "VIP Customers",
      "contacts_count": 42
    }
  ],
  "request_id": "req_3e4f5a6b"
}
POST

/api/v1/groups/{id}/contacts

Associates an array of contact UUIDs with the specified group.

Request Body Parameters

FieldTypeRequiredDescription
contact_idsarrayYesArray of contact UUIDs to add

Code Example (5 Languages)

curl -X POST "https://app.pingstack.in/api/v1/groups/GROUP_ID/contacts" \
  -H "Authorization: Bearer ps_secret_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contact_ids": ["c1a2b3c4-...", "c5d6e7f8-..."]}'

Response Example

JSON
{
  "success": true,
  "data": {
    "group_id": "g1...",
    "added_count": 2,
    "total_contacts": 44
  },
  "request_id": "req_4f5a6b7c"
}