Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01

Query Parameters

alias
string

Filter by customer alias (external ID)

Example:

"ext_customer_1"

csm_id
string[]

Filter by customer success manager user ID (comma-separated to match any)

Example:

"usr_abc123"

email
string

Filter by contact email address

Example:

"john@example.com"

has_active_subscriptions
boolean

Filter by whether the customer has active subscriptions

integration_ids
string[]

Filter by external integration IDs (comma-separated to match any)

Example:

"intg_abc123"

limit
integer<int64>
required

Number of items to return per page

Example:

20

offset
integer<int64>
required

Number of items to skip

Example:

0

sales_owner_id
string[]

Filter by sales owner user ID (comma-separated to match any)

Example:

"usr_abc123"

sort
string
required

Sort field and direction in format field:order

Example:

"name:asc"

tag_ids
string[]

Filter by tag IDs (comma-separated to match any)

Example:

"tag_abc123"

Response

Success

data
object[]
required

List of customers

pagination
object
required

Pagination metadata