List user profiles

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/user_profiles

Return the workspace’s user profiles, newest first.

For how this fits into a full workflow, see User profiles.

Headers

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.
syntic-betaYes, while in previewagents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.

Query parameters

ParameterTypeDefaultDescription
external_idstringExact match.
attributestringkey:value filter, for example plan:gold. Repeat for AND.
limitinteger201 to 100.
after_idstringNext page: the previous page’s last_id.
before_idstringPrevious page: the previous page’s first_id.

Response

200 OK, Content-Type: application/json

{
  "data": [
    {
      "id": "uprof_01JCF5H7K9M1P3R5T7V9",
      "type": "user_profile",
      "external_id": "cust-4821",
      "display_name": "Dana Lee",
      "locale": "en-GB",
      "timezone": "Europe/London",
      "attributes": {
        "plan": "gold",
        "region": "uk-south"
      },
      "memory_scope": "user:cust-4821",
      "session_count": 17,
      "created_at": "2026-10-02T09:00:00Z",
      "updated_at": "2026-11-05T10:00:00Z"
    }
  ],
  "has_more": false,
  "first_id": "uprof_01JCF5H7K9M1P3R5T7V9",
  "last_id": "uprof_01JCF5H7K9M1P3R5T7V9"
}
FieldTypeDescription
dataarrayThe objects on this page, newest first.
has_morebooleantrue when another page exists after this one.
first_idstring or nullPass as before_id to go back a page.
last_idstring or nullPass as after_id to get the next page.

Examples

curl -sS "https://app.syntic.ai/v1/user_profiles?attribute=plan:gold&limit=50" \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "syntic-beta: agents-2026-11-01"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?