GEgenpage
Audiences

Get the list of audiences.

Changed on

This endpoint is used to get the list of audiences.

Audience 0 is the built-in "Default Audience": every lead in the workspace that has not been added to an audience of its own.

get/api/external/v1/audiences/get-list

Request

Query parameters

workspace_idinteger required

The workspace to list audiences for.

Example:55

Response

object[] required

Example response

[
  {
    "id": 0,
    "name": "Default Audience",
    "description": "Leads that have not been added to a specific audience",
    "color": null,
    "lead_count": 12,
    "project_id": 55,
    "created_at": "2025-01-01T00:00:00.000000Z",
    "updated_at": "2025-01-01T00:00:00.000000Z"
  },
  {
    "id": 1,
    "name": "Enterprise prospects",
    "description": null,
    "color": "#4F46E5",
    "lead_count": 340,
    "project_id": 55,
    "created_at": "2026-08-01T10:00:00.000000Z",
    "updated_at": "2026-08-01T10:00:00.000000Z"
  }
]

Changes

  • dd3f47f72f7aRevision changes
    • breaking

      added the new required query request parameter workspace_id

    • breaking

      removed the request body

    • breaking

      the response's body type changed from object to array for status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status