API

List Audience Profiles

Retrieve all audience profiles configured for a project.

GET/v1/projects/{projectId}/audiences

Path Parameters

The project ID.

Query Parameters

Maximum number of profiles to return (1-100).

Number of profiles to skip for pagination.

Response

Returns an array of audience profile objects.

Profile Object

Unique profile identifier.

Display name of the profile.

URL-safe identifier. Immutable after creation.

Optional description of the profile.

Array of audience tags this profile grants access to.

ISO 8601 timestamp when the profile was created.

ISO 8601 timestamp when the profile was last updated.

Example

curl https://api.syntext.dev/v1/projects/proj_abc123/audiences \
-H "Authorization: Bearer stx_abc12345_..."

import { Syntext } from '@syntext/sdk'

const client = new Syntext('stx_abc12345_...')

const profiles = await client.audiences.list('proj_abc123')

from syntext import Syntext

client = Syntext("stx_abc12345_...")

profiles = client.audiences.list("proj_abc123")

Response

{
  "data": [
    {
      "id": "aud_xyz789",
      "name": "Acme Corporation",
      "slug": "acme-corp",
      "description": "Enterprise partner with full access",
      "audiences": ["otc", "virtual-accounts", "transfers"],
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-02-20T14:45:00Z"
    },
    {
      "id": "aud_def456",
      "name": "Beta Testers",
      "slug": "beta-testers",
      "description": "Early access program participants",
      "audiences": ["beta"],
      "createdAt": "2024-01-10T08:00:00Z",
      "updatedAt": "2024-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 20,
    "offset": 0
  }
}

Was this page helpful?