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>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>'
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "customer_type": "Business",
      "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"
      ],
      "status": "UserRequired",
      "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
required

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

​
page_size
integer<uint32>
default:10

Paging: the requested page size (max 100)

​
search_term
string

A search term to filter the customers

Maximum string length: 256

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