List Customers

GET

accounts

curl "https://api.alguna.io/accounts?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://api.alguna.io/accounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=10' \
  --data-urlencode 'filters=[{"field":"has_active_subscriptions","operator":"eq","value":"true"}]' \
  --data-urlencode 'sort=name:asc'

const customers = await alguna.accounts.list({
  page: 1,
  limit: 25,
  filters: [
    { field: "has_active_subscriptions", operator: "eq", value: "true" }
  ],
  sort: "name:asc"
});

{
  "pageCount": 1,
  "data": [
    {
      "id": "uSOBHVom",
      "name": "Waystar RoyCo",
      "aliases": ["waystarroyco"],
      "contacts": [],
      "billingAddress": null,
      "currency": "USD",
      "createdAt": "2023-08-15T07:18:45.843467Z",
      "updatedAt": "2023-09-05T13:59:18.318773Z"
    },
    {
      "id": "ywgWhtGp",
      "name": "GoJo",
      "aliases": ["JoGo"],
      "billingAddress": {
        "line1": "123 Main St",
        "line2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001"
      },
      "contacts": [
        {
          "id": "OLgPyqFF",
          "email": "sales@gojo.com",
          "firstName": "Henry",
          "lastName": "Sules",
          "isPrimary": true,
          "emailPreferences": ["updates"]
        },
        {
          "id": "FdqPzqFG",
          "email": "finance@gojo.com",
          "firstName": "Accounts",
          "lastName": "Receivable",
          "isPrimary": false,
          "emailPreferences": ["billing"]
        }
      ],
      "createdAt": "2023-09-05T21:54:54.609688Z",
      "updatedAt": "2023-09-05T21:54:54.609689Z"
    }
  ]
}

Retrieves a paginated list of all customer accounts. You can filter and sort the results using query parameters.

Query Parameters

integer

default:"1"

The page number to retrieve (1-indexed).

integer

default:"10"

The number of customers to return per page. Must be one of: 5, 10, 25, 50, or 100. Values exceeding 100 are capped automatically.

string

A JSON-encoded array of filter objects. Each filter object has the following properties:

Show Filter Object

string

required

The field to filter on. Supported fields:

Field	Operators	Description
`sales_owner_id`	`eq`, `in`	The sales owner user ID
`csm_id`	`eq`, `in`	The customer success manager user ID
`tag_ids`	`in`	Tag IDs associated with the account
`has_active_subscriptions`	`eq`	Whether the account has active subscriptions (`true` or `false`)
`integration_ids`	`in`	External integration IDs linked to the account

string

required

The comparison operator.

Operator	Description
`eq`	Exact match
`in`	Matches any value in a comma-separated list

string

required

The value to match against. For the in operator, use comma-separated values.

string

Sort specification in field:order format. Order is either asc (ascending) or desc (descending).Sortable fields: name.

string

Search customers by name.

curl "https://api.alguna.io/accounts?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://api.alguna.io/accounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=10' \
  --data-urlencode 'filters=[{"field":"has_active_subscriptions","operator":"eq","value":"true"}]' \
  --data-urlencode 'sort=name:asc'

const customers = await alguna.accounts.list({
  page: 1,
  limit: 25,
  filters: [
    { field: "has_active_subscriptions", operator: "eq", value: "true" }
  ],
  sort: "name:asc"
});

Response

{
  "pageCount": 1,
  "data": [
    {
      "id": "uSOBHVom",
      "name": "Waystar RoyCo",
      "aliases": ["waystarroyco"],
      "contacts": [],
      "billingAddress": null,
      "currency": "USD",
      "createdAt": "2023-08-15T07:18:45.843467Z",
      "updatedAt": "2023-09-05T13:59:18.318773Z"
    },
    {
      "id": "ywgWhtGp",
      "name": "GoJo",
      "aliases": ["JoGo"],
      "billingAddress": {
        "line1": "123 Main St",
        "line2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001"
      },
      "contacts": [
        {
          "id": "OLgPyqFF",
          "email": "sales@gojo.com",
          "firstName": "Henry",
          "lastName": "Sules",
          "isPrimary": true,
          "emailPreferences": ["updates"]
        },
        {
          "id": "FdqPzqFG",
          "email": "finance@gojo.com",
          "firstName": "Accounts",
          "lastName": "Receivable",
          "isPrimary": false,
          "emailPreferences": ["billing"]
        }
      ],
      "createdAt": "2023-09-05T21:54:54.609688Z",
      "updatedAt": "2023-09-05T21:54:54.609689Z"
    }
  ]
}

string

The Alguna ID of the account.

string

The name of the account.

string

The name of the primary contact for the account.

string

The email address of the primary contact for the account.

[]string

The list of alternative or external IDs for the account. These can be used to identify the account in place of the Alguna id.

string

The account tax identifier provided by the local authority.

string

Displays if account is eligible or not eligible for tax treatment.

string

The email address to which invoices should be sent. If not provided, the contactEmail will be used.

string

The country where the accounts is located for tax authorities

string

The ISO 4217 currency in which the account is billed.

datetime

The date and time at which the account was created.

datetime

The date and time at which the account was last updated.

integer

Total number of pages available based on the current limit.

integer

The number of items per page used for this request.

⌘I

curl "https://api.alguna.io/accounts?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://api.alguna.io/accounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=10' \
  --data-urlencode 'filters=[{"field":"has_active_subscriptions","operator":"eq","value":"true"}]' \
  --data-urlencode 'sort=name:asc'

const customers = await alguna.accounts.list({
  page: 1,
  limit: 25,
  filters: [
    { field: "has_active_subscriptions", operator: "eq", value: "true" }
  ],
  sort: "name:asc"
});

{
  "pageCount": 1,
  "data": [
    {
      "id": "uSOBHVom",
      "name": "Waystar RoyCo",
      "aliases": ["waystarroyco"],
      "contacts": [],
      "billingAddress": null,
      "currency": "USD",
      "createdAt": "2023-08-15T07:18:45.843467Z",
      "updatedAt": "2023-09-05T13:59:18.318773Z"
    },
    {
      "id": "ywgWhtGp",
      "name": "GoJo",
      "aliases": ["JoGo"],
      "billingAddress": {
        "line1": "123 Main St",
        "line2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001"
      },
      "contacts": [
        {
          "id": "OLgPyqFF",
          "email": "sales@gojo.com",
          "firstName": "Henry",
          "lastName": "Sules",
          "isPrimary": true,
          "emailPreferences": ["updates"]
        },
        {
          "id": "FdqPzqFG",
          "email": "finance@gojo.com",
          "firstName": "Accounts",
          "lastName": "Receivable",
          "isPrimary": false,
          "emailPreferences": ["billing"]
        }
      ],
      "createdAt": "2023-09-05T21:54:54.609688Z",
      "updatedAt": "2023-09-05T21:54:54.609689Z"
    }
  ]
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response