Skip to main content
GET
/
customers
/
{id}
/
recipients
List all recipients
curl --request GET \
  --url https://api.platform.dakota.xyz/customers/{id}/recipients \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
      "name": "Acme Corporation",
      "status": "active",
      "address": {
        "street1": "123 Main St",
        "city": "San Francisco",
        "country": "US",
        "street2": "Apt 4B",
        "street3": "Building C",
        "region": "California",
        "postal_code": "94105"
      },
      "destinations": [
        {
          "destination_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
          "destination_type": "crypto",
          "name": "My Ethereum Wallet",
          "crypto_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "family": "evm",
          "network_id": "ethereum-mainnet"
        }
      ]
    }
  ],
  "meta": {
    "total_count": 100,
    "has_more_after": true,
    "has_more_before": false,
    "limit_reached": false
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Query Parameters

​
limit
integer
default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for use in pagination. starting_after is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with ID 2B5J8KZ9N7M1K3P6Q8R4T7V9, your subsequent call can include starting_after=2B5J8KZ9N7M1K3P6Q8R4T7V9 in order to fetch the next page of the list. KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

​
ending_before
string

A cursor for use in pagination. ending_before is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with ID 2B5J8KZ9N7M1K3P6Q8R4T7V9, your subsequent call can include ending_before=2B5J8KZ9N7M1K3P6Q8R4T7V9 in order to fetch the previous page of the list. KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Response

List of recipients

Wrapper for paginated list responses

​
data
Recipient Response · object[]
required

List of objects returned by the API

​
meta
object
required

Meta information about the response