Organizations

Manage organizations (sub-accounts) under your partner account. Create, update, and configure organizations, pixel settings, and retrieve visitor data.

List Organizations

List organizations with pagination and filtering.

Request:

GET /partner/organizations

Query Parameters:

Parameter
Type
Description

page

integer

Page number (default: 1)

pageSize

integer

Items per page (default: 20)

status

string

Filter by status: active, canceled, suspended

search

string

Search by organization name

externalId

string

Filter by external ID

Response:

{
  "organizations": [
    {
      "id": "uuid",
      "name": "Acme Corp",
      "externalId": "acme-123",
      "status": "active",
      "tier": "paid",
      "credits": 1000,
      "metadata": {},
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "pageSize": 20
}

Example:


Create Organization

Create a new organization under the partner account.

Request:

Body:

Field
Type
Required
Description

name

string

Yes

Organization display name

externalId

string

No

Your external reference ID

ownerUserId

string

No

User ID for the organization owner

initialCredits

integer

No

Initial credit allocation

metadata

object

No

Custom key-value metadata

tier

string

No

trial or paid (default: trial)

billingPeriod

string

No

monthly or annual

billingDayOfMonth

integer

No

Day of month for billing (1-28)

productType

string

No

B2B or B2C

Response:

Example:


Get Organization

Retrieve a single organization by ID.

Request:

Response:


Update Organization

Update organization details.

Request:

Body:

All fields are optional.

Response:


Delete Organization

Soft delete or disable an organization.

Request:

Response: 204 No Content


Update Organization Status

Enable or disable an organization.

Request:

Body:

Response:


Update Organization Tier

Change the organization tier between trial and paid.

Request:

Body:

Valid values: trial, paid

Response:


Update Organization Billing

Update billing configuration for an organization.

Request:

Body:

All fields are optional.

Response:


Get Pixel Config

Retrieve the tracking pixel configuration for an organization.

Request:

Response:


Update Pixel Config

Update allowed referrers for the tracking pixel.

Request:

Body:

Response:


List Visitors

List visitors for an organization with pagination.

Request:

Query Parameters:

Parameter
Type
Description

page

integer

Page number (default: 1)

limit

integer

Items per page (default: 20)

Response:

Example:

Last updated