v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Recipients (Send to Others)

List Recipients

Retrieve all recipients for a specific customer with optional search and pagination.

Functionality:

Returns recipients ordered by creation time (most recent first)
Supports search by name, nickname, or email

get/v1/customers/{customer_id}/recipients/list

Path parameters

customer_idstring required

Unique identifier of the customer

Query parameters

searchstring

Search string to filter by name, nickname, or email

pageinteger

Page number (starts from 1, default: 1)

sizeinteger

Number of items per page (1-100, default: 10)

Response

Successfully retrieved list of recipients

totalinteger nullable

Example response

{
  "list": [
    {
      "recipient_id": "4728c2b9-6df7-11f0-b1f6-6a7838eca3f8",
      "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
      "business_type": "INDIVIDUAL",
      "full_name": "John Doe",
      "nickname": "John's Business",
      "email": "john.doe@example.com",
      "relationship": "VENDOR",
      "status": "active",
      "address": {
        "full_address": "490 2nd St Suite 300, San Francisco, CA 94107",
        "country_code": "USA",
        "address_line1": "490 2nd St",
        "address_line2": "Suite 300",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94107"
      },
      "created_at": "2025-10-29T02:46:25.096305Z",
      "modified_at": "2025-10-29T02:46:25.096305Z"
    }
  ],
  "total": 1024
}