/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference List Audience Profiles

List Audience Profiles

List all audience profiles for a project

GET/v1/projects/{projectId}/audiencesTry it
Session token

Retrieve all audience profiles configured for a project, sorted by name. The list is not paginated — every profile is returned in one response.

Note

Org membership is required. Being signed in is not enough: you must be a member of the organization that owns {projectId}. A project you cannot see returns 404, one you are not a member of returns 403 with the forbidden code — see Authentication.

accessToken is returned to workspace owners and admins only. It is the code that unlocks this profile's gated pages, so for a member the field is left out of the response entirely. Every other field is the same for every role.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Response

Returns an array of audience profile objects.

Profile Object

NameDescription
id:string
Unique profile identifier.
projectId:string
The project the profile belongs to.
name:string
Display name of the profile.
slug:string
URL-safe identifier. Immutable after creation.
description:string
Optional description of the profile.
audiences:string[]
Array of audience tags this profile grants access to.
accessToken:string | null
The profile's access code, or null if none has been created yet. Owners and admins only — omitted for members. Create one with Generate Access Token.
lastUsedAt:string | null
When the profile's access token was last accepted — by doc-site search or the AI assistant (sent as the x-audience-token header), or when a reader unlocked gated pages with it. Updated at most once every 5 minutes per profile, so treat it as approximate. null if the token has never been used.
createdAt:string
ISO 8601 timestamp when the profile was created.
updatedAt:string
ISO 8601 timestamp when the profile was last updated.
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/proj_abc123/audiences \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
json
{
"data": [
{
"id": "aud_xyz789",
"projectId": "proj_abc123",
"name": "Acme Corporation",
"slug": "acme-corp",
"description": "Enterprise partner with full access",
"audiences": ["otc", "virtual-accounts", "transfers"],
"lastUsedAt": "2024-02-21T09:12:00Z",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-02-20T14:45:00Z"
},
{
"id": "aud_def456",
"projectId": "proj_abc123",
"name": "Beta Testers",
"slug": "beta-testers",
"description": "Early access program participants",
"audiences": ["beta"],
"lastUsedAt": null,
"createdAt": "2024-01-10T08:00:00Z",
"updatedAt": "2024-01-10T08:00:00Z"
}
]
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext