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

{
  "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

​
page
integer
default:"1"
The page number to retrieve (1-indexed).
​
limit
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.
​
filters
string
A JSON-encoded array of filter objects. Each filter object has the following properties:
​
sort
string
Sort specification in field:order format. Order is either asc (ascending) or desc (descending).Sortable fields: name.
​
search
string
Search customers by name.
curl "https://api.alguna.io/accounts?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
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"
    }
  ]
}
​
id
string
The Alguna ID of the account.
​
name
string
The name of the account.
​
contactName
string
The name of the primary contact for the account.
​
contactEmail
string
The email address of the primary contact for the account.
​
aliases
[]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.
​
taxId
string
The account tax identifier provided by the local authority.
​
taxStatus
string
Displays if account is eligible or not eligible for tax treatment.
​
billingEmail
string
The email address to which invoices should be sent. If not provided, the contactEmail will be used.
​
taxCountry
string
The country where the accounts is located for tax authorities
​
currency
string
The ISO 4217 currency in which the account is billed.
​
createdAt
datetime
The date and time at which the account was created.
​
updatedAt
datetime
The date and time at which the account was last updated.
​
pageCount
integer
Total number of pages available based on the current limit.
​
limit
integer
The number of items per page used for this request.