Fetch Groups

Retrieve the contact groups available on your Bulkit account.

Last updated · Markdown version

Short description

Retrieve the contact groups available to the authenticated Bulkit account.

HTTP method and path

HTTP
GET /api/v2/contacts/groups

Authorization requirements

This endpoint supports:

  • Bearer token (recommended): Authorization: Bearer <your_api_token>
  • Legacy headers: X-API-Key and X-API-Secret
  • URL query parameter: ?apikey=<your_api_token>

Authorization example

HTTP
Authorization: Bearer bk_live_8n6JQv3K1h9Lp0Md

Parameters

This endpoint does not require a request body.

Authentication parameters

ParameterLocationRequiredTypeDescription
AuthorizationHeaderYes (recommended)stringBearer <your_api_token>
X-API-KeyHeaderOptional (legacy)stringYour Bulkit key
X-API-SecretHeaderOptional (legacy)stringYour Bulkit secret
apikeyQueryOptional fallbackstringAPI key used in URL authorization

Request examples

cURL / Bash
curl -X GET "https://api.bulkitsms.com/api/v2/contacts/groups" \
  -H "Authorization: Bearer bk_live_8n6JQv3K1h9Lp0Md"

Success response example

JSON
{
  "status": "success",
  "data": [
    {
      "id": 14,
      "name": "Customers",
      "contact_count": 248
    }
  ]
}

Error response examples

JSON
{
  "status": "error",
  "message": "Invalid credentials"
}

Notes

  • call this endpoint first if your integration needs to validate or look up a destination group ID
  • contact_count can be used to power sync dashboards and reconciliation jobs