List Buyer Profiles

List the authenticated user’s buyer profiles, newest first. Paginate with the opaque cursor from nextCursor.

API scope required: agent-checkouts.buyer-profiles.read

GET /unstable/agent-checkouts/buyer-profiles

List Buyer Profiles

cURL

curl --request GET \
  --url https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles"

headers = {
    "X-API-KEY": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-KEY': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles', 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://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles"

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

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles")
  .header("X-API-KEY", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles")

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

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

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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shipping": {
        "addressLines": [
          "<string>"
        ],
        "locality": "<string>",
        "countryCode": "<string>",
        "administrativeAreaCode": "<string>",
        "postalCode": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "label": "<string>",
      "name": {
        "first": "<string>",
        "last": "<string>"
      },
      "contact": {
        "email": "[e-mail]",
        "phone": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Client-side API key (ck_...) with the agent-checkouts.* scopes.

Authorization · string · header · required

JWT identifying the end user, issued by an external auth provider your project trusts.

Query Parameters

cursor · string

Opaque pagination cursor from a previous response's nextCursor.

limit · integer

Maximum number of profiles to return per page.

Required range: 1 <= x <= 100

Response

200

application/json

Returns one page of the user's buyer profiles.

One page of buyer profiles, newest first.

data · object[] · required

The buyer profiles in this page.

Show child attributes

nextCursor · string | null · required

Opaque cursor for the next page, or null on the last page.