List all customers

GET 
/v1/customers

Retrieves a paginated list of customers. This endpoint supports:

• Filtering for direct children only
• Including related entities (wallets and portfolios)
• Pagination and sorting

Request

Query Parameters

include string[]

Possible values: [portfolios, wallets]

Fields to include in the response

sortBy string

Possible values: [firstName, lastName, email, id]

Field to sort by

limit number
offset number

Responses

200

Successfully retrieved the list of customers with pagination information.

application/json

Schema

Schema

traceId string
message string

data

object[]

Array [

id stringrequired

name stringrequired

type stringrequired

portfolios

object[]

Array [

id stringrequired

The ID of the portfolio

default booleanrequired

Whether this portfolio is the default portfolio

wallets string[]required

The IDs of the wallets in the portfolio

]

onboardingId string

The ID of the most recent onboarding for this customer

]

pagination

object

totalResults numberrequired

hasMoreResults booleanrequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "john doe",
      "type": "LEGAL",
      "portfolios": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "default": true,
          "wallets": [
            "string"
          ]
        }
      ],
      "onboardingId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "pagination": {
    "totalResults": 0,
    "hasMoreResults": true
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...