Skip to main content
GET
/
unstable
/
agent-checkouts
/
buyer-profiles
/
{id}
Get Buyer Profile
curl --request GET \
  --url https://www.crossmint.com/api/unstable/agent-checkouts/buyer-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-KEY: <api-key>'
import requests

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

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/{id}', 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/{id}",
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/{id}"

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/{id}")
.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/{id}")

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
{
  "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": "jsmith@example.com",
    "phone": "<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.

Path Parameters

id
string<uuid>
required

The buyer profile id (returned by create).

Response

Returns the buyer profile.

The full buyer profile, returned by create, get, list items, and update.

id
string<uuid>
required

The buyer profile id. Pass it as buyerProfileId when creating a checkout.

shipping
object
required

Global shipping address. administrativeAreaCode and postalCode are nullable for global-address compatibility.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
label
string

Optional human-readable label for the profile.

Required string length: 1 - 120
name
object

Optional buyer name. Both parts are optional.

contact
object

Optional buyer contact details.