GET
/
buyers
curl --request GET \
  --url https://api.{id}.gr4vy.app/buyers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "buyer",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "merchant_account_id": "default",
      "display_name": "John Doe",
      "external_identifier": "buyer-12345",
      "billing_details": {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "address": {
          "city": "San Jose",
          "country": "US",
          "postal_code": "94560",
          "state": "California",
          "state_code": "US-CA",
          "house_number_or_name": "10",
          "line1": "Stafford Appartments",
          "line2": "29th Street",
          "organization": "Gr4vy"
        },
        "tax_id": {
          "value": "12345678931",
          "kind": "us.ein"
        }
      },
      "account_number": "<string>",
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-gr4vy-merchant-account-id
string | null

The ID of the merchant account to use for this request.

Examples:

"default"

Query Parameters

​
cursor
string | null

A pointer to the page of results to return.

Examples:

"ZXhhbXBsZTE"

​
limit
integer
default:20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100
Examples:

20

​
search
string | null

Filters the results to only the buyers for which the display_name or external_identifier matches this value.

Examples:

"John"

​
external_identifier
string | null

Filters the results to only the buyers for which the external_identifier matches this value.

Examples:

"buyer-12345"

Response

200
application/json
Successful Response

The response is of type object.