Audiences

List Audiences

get

Returns all your saved audiences.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50

Responses

200

Successful Response

application/json

totalintegerRequired

pageinteger · min: 1Required

sizeinteger · min: 1Required

pagesintegerRequired

422

Validation Error

application/json

get/audiences

GET /audiences HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "members_count": 1,
      "engine": 1,
      "is_private": true,
      "filters": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lookback_window": 1,
      "status": "text",
      "user": "text",
      "last_synced": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 1,
  "pages": 1
}

Create Audience

post

Creates a new audience from the provided filters. Building happens asynchronously in the background — the audience will have status: queued until the build completes.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Body

namestringRequired

A name for this audience.

descriptionstring · nullableOptional

lookback_windowinteger · min: 1 · nullableOptional

How many days of session history to include when building the audience.

Default: 60

refresh_cronstring · nullableOptionalDefault: 55 15 * * *

Responses

200

Successful Response

application/json

idstringRequired

namestringRequired

descriptionstring · nullableOptional

members_countinteger · nullableOptional

engineinteger · nullableOptional

is_privateboolean · nullableOptional

lookback_windowinteger · nullableOptional

statusstring · nullableOptional

userstring · nullableOptional

last_syncedstring · date-time · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

post/audiences

POST /audiences HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 517

{
  "name": "text",
  "filters": {
    "visitors": [
      {
        "field": "text",
        "method": "equals",
        "value": null
      }
    ],
    "sessions": [
      {
        "field": "text",
        "method": "equals",
        "value": null
      }
    ],
    "pages": [
      {
        "field": "text",
        "method": "equals",
        "value": null
      }
    ],
    "buyer_intent": [
      {
        "field": "text",
        "method": "equals",
        "value": null
      }
    ],
    "enrichment": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "field": "text",
          "method": "equals",
          "value": null
        }
      ]
    },
    "ml": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "field": "text",
          "method": "equals",
          "value": null
        }
      ]
    }
  },
  "description": "text",
  "lookback_window": 60,
  "refresh_cron": "55 15 * * *"
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "members_count": 1,
  "engine": 1,
  "is_private": true,
  "filters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lookback_window": 1,
  "status": "text",
  "user": "text",
  "last_synced": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Get Audience

get

Returns a single audience by ID, including its filters and current build status.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Path parameters

idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringRequired

descriptionstring · nullableOptional

members_countinteger · nullableOptional

engineinteger · nullableOptional

is_privateboolean · nullableOptional

lookback_windowinteger · nullableOptional

statusstring · nullableOptional

userstring · nullableOptional

last_syncedstring · date-time · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

422

Validation Error

application/json

get/audiences/{id}

GET /audiences/{id} HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "members_count": 1,
  "engine": 1,
  "is_private": true,
  "filters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "lookback_window": 1,
  "status": "text",
  "user": "text",
  "last_synced": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete Audience

delete

Deletes an audience and all its members.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Path parameters

idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringRequired

messagestringRequired

422

Validation Error

application/json

delete/audiences/{id}

DELETE /audiences/{id} HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "message": "text"
}

Refresh Audience

post

Triggers a rebuild of the audience. Returns 400 if the audience is already syncing.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Path parameters

idstringRequired

Responses

200

Successful Response

application/json

audience_idstringRequired

namestringRequired

statusstring · nullableOptional

422

Validation Error

application/json

post/audiences/{id}/refresh

POST /audiences/{id}/refresh HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "audience_id": "text",
  "name": "text",
  "status": "text"
}

List Audience Members

get

Returns the visitor profiles that belong to this audience.

Authorizations

AuthorizationstringRequired

Bearer token for authentication

Path parameters

idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50

Responses

200

Successful Response

application/json

totalintegerRequired

pageinteger · min: 1Required

sizeinteger · min: 1Required

pagesintegerRequired

422

Validation Error

application/json

get/audiences/{id}/members

GET /audiences/{id}/members HTTP/1.1
Host: api.getuntitled.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "first_name": "text",
      "personal_city": "text",
      "married": "text",
      "company_phone": "text",
      "company_sic": "text",
      "company_employee_count": "text",
      "un_processed_timestamp": 1,
      "last_name": "text",
      "personal_state": "text",
      "income_range": "text",
      "professional_address2": "text",
      "company_naics": "text",
      "primary_industry": "text",
      "un_updated_timestamp": 1,
      "business_email": "text",
      "personal_zip": "text",
      "net_worth": "text",
      "professional_city": "text",
      "company_address": "text",
      "business_email_validation_status": "text",
      "mobile_phone": "text",
      "personal_zip4": "text",
      "homeowner": "text",
      "professional_state": "text",
      "company_city": "text",
      "business_email_last_seen": "2026-01-01T00:00:00.000Z",
      "hem": "text",
      "linkedin_url": "text",
      "personal_email": "text",
      "job_title": "text",
      "professional_zip": "text",
      "company_state": "text",
      "personal_email_validation_status": "text",
      "record_uuid": "text",
      "personal_address": "text",
      "personal_phone": "text",
      "seniority_level": "text",
      "professional_zip4": "text",
      "company_zip": "text",
      "personal_email_last_seen": "2026-01-01T00:00:00.000Z",
      "personal_address2": "text",
      "gender": "text",
      "department": "text",
      "company_name": "text",
      "company_linkedin_url": "text",
      "last_updated": "2026-01-01T00:00:00.000Z",
      "age_range": "text",
      "professional_address": "text",
      "company_domain": "text",
      "company_revenue": "text",
      "ip": "text",
      "last_session_date": "2026-01-01T00:00:00.000Z",
      "last_session_exit_url": "text",
      "last_session_entry_url": "text",
      "last_session_entry_referer_url": "text",
      "total_session_count": 1,
      "last_session_est_duration": 1,
      "last_session_total_pages_visited": 1,
      "lead_category": "text",
      "tag_id": "text",
      "file_type": "text"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 1,
  "pages": 1
}

PreviousAuth NextIdentity

Last updated 1 day ago

Was this helpful?