GET
/
buyers
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/buyers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "billing_details": {
        "address": {
          "city": "London",
          "country": "GB",
          "house_number_or_name": "10",
          "line1": "10 Oxford Street",
          "line2": "New Oxford Court",
          "organization": "Gr4vy",
          "postal_code": "789123",
          "state": "Greater London",
          "state_code": "GB-LND"
        },
        "email_address": "john@example.com",
        "first_name": "John",
        "last_name": "Lunn",
        "phone_number": "+1234567890",
        "tax_id": {
          "kind": "gb.vat",
          "value": "12345678931"
        },
        "type": "billing-details"
      },
      "created_at": "2013-07-16T19:23:00.000+00:00",
      "display_name": "John L.",
      "external_identifier": "user-789123",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "merchant_account_id": "default",
      "type": "buyer",
      "updated_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "null"
}

This endpoint requires the buyers.read scope. The buyers.billing-details.read scope is needed to see all personally identifiable information.

Authorizations

Authorization
string
headerrequired

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

Query Parameters

search
string

Filters the results to only the buyers for which the display_name or external_identifier matches this value. This field allows for a partial match, matching any buyer for which either of the fields partially or completely matches.

Please do not use this query parameter in a production application, as this API call is very inefficient and may negatively impact transaction performance.

external_identifier
string

Filters the results to only the items for which the buyer has an external_identifier that exactly matches this value.

limit
integer
default: 20

Defines the maximum number of items to return for this request.

cursor
string

A cursor that identifies the page of results to return. This is used to paginate the results of this API.

For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the next_cursor field. Similarly the previous_cursor can be used to reverse backwards in the list.

Response

200 - application/json
items
object[]

A list of buyers.

limit
integer
default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.