Skip to main content
GET
/
customers
Get all Customers
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identification_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "name": "<string>",
      "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "signing_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "active_email": "<string>",
      "external_id": "<string>",
      "spending_limit_euro": "<string>"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner

Query Parameters

​
cursor
string<uuid>

Paging: the cursor field from previous page

​
prev_cursor
string<uuid>

Paging: the cursor field for backward pagination

​
page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

Required range: x <= 100
​
search_term
string

A search term to filter the customers

Maximum string length: 256
​
status
enum<string>[]

Filter by customer status (comma-separated or repeated values)

The status of the Customer

Available options:
UserRequired,
SigningsRequired,
IdentificationRequired,
Active,
Suspended
​
identification_status
enum<string>[]

Filter by the customer's most-recent identification status

The Process status of the identification

The various state transitions an identification can go through.

Available options:
Pending,
Processed,
PendingReview,
Approved,
Declined,
Expired
​
sort_order
enum<string>

Sort order: "asc" for oldest first, "desc" for newest first (default)

Available options:
asc,
desc

Response

GET ALL Customer Succeeded

PagedList

A list of items with cursors used to fetch the next or previous page

​
items
Customer · object[]
required

The list of items

​
cursor
string<uuid>

The cursor used to fetch the next page

​
prev_cursor
string<uuid>

The cursor used to fetch the previous page