Skip to main content

List client accounts

Query Parameters
limitstring^\d+$

Maximum number of resources to return, between 1 and 100.

afterstring

A cursor for use in pagination.

The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.

namestring^[a-zA-Z0-9_]{3,}$

Filter accounts based on name (case insensitive).

The value can appear at the beggining, middle or end on the actual account name.

Returns
has_morebooleanrequired

Whether or not there are more elements available after this set.

If false, this set comprises the end of the array.

Part of a paginated response.

next_cursorstringrequired

The cursor value to be used as the after parameter for fetching the next page of results.

null if has_more is false.

dataarray of objectrequired

An array of Client Account objects

Part of a paginated response.

  • GET /accounts/client
    • curl 'https://api.lune.co/v1/accounts/client' \
  -H 'Authorization: Bearer <API_KEY>'
  • Response
    • {
  "has_more": true,
  "next_cursor": "next_cursor",
  "data": [
    {
      "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
      "name": "ACME",
      "beneficiary": "ACME Inc",
      "currency": "USD",
      "type": "live",
      "organisation_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
      "logo": null,
      "bundle_portfolio_id": null
    }
  ]
}