Get all Customers

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.iron.xyz/api/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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>",
      "identification_status": "Pending",
      "spending_limit_euro": "<string>"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

GET

customers

Get all Customers

curl --request GET \
  --url https://api.sandbox.iron.xyz/api/customers \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.iron.xyz/api/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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>",
      "identification_status": "Pending",
      "spending_limit_euro": "<string>"
    }
  ],
  "cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prev_cursor": null
}

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

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

X-API-Version

string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01.

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,

Archived

customer_type

enum<string>[]

Filter by customer type (Person or Business)

CustomerType

Customers can either be a commercial business or a natural person

Available options:

Business,

Person

has_transactions

boolean

When true, only customers with at least one transaction; when false, only customers without any. Omit to disable the filter.

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

Show child attributes

cursor

string<uuid>

The cursor used to fetch the next page

prev_cursor

string<uuid>

The cursor used to fetch the previous page

⌘I