GET
/
customers
Get all customers
curl --request GET \
  --url https://api.bridge.xyz/v0/customers \
  --header 'Api-Key: <api-key>'
{
  "data": [
    {
      "id": "cust_ind",
      "first_name": "John",
      "last_name": "Doe",
      "email": "johndoe@johndoe.com",
      "status": "active",
      "type": "individual",
      "has_accepted_terms_of_service": true,
      "address": {
        "street_line_1": "123 Washington St",
        "street_line_2": "Apt 2F",
        "city": "New York",
        "postal_code": "10001",
        "state": "NY",
        "country": "USA"
      },
      "rejection_reasons": [],
      "requirements_due": [
        "external_account"
      ],
      "future_requirements_due": [
        "id_verification"
      ],
      "endorsements": [
        {
          "name": "base",
          "status": "approved"
        },
        {
          "name": "sepa",
          "status": "incomplete",
          "additional_requirements": [
            "kyc_with_proof_of_address",
            "tos_v2_acceptance"
          ]
        }
      ],
      "created_at": "2020-01-01T00:00:00.000Z",
      "updated_at": "2020-01-02T00:00:00.000Z"
    },
    {
      "id": "cust_biz",
      "first_name": "Biz Corp",
      "last_name": "_",
      "status": "active",
      "type": "individual",
      "email": "harperstern@harperstern.com",
      "has_accepted_terms_of_service": true,
      "address": {
        "street_line_1": "1 5th avenue",
        "city": "New York",
        "state": "NY",
        "postal_code": "10010",
        "country": "USA"
      },
      "rejection_reasons": [],
      "requirements_due": [
        "external_account"
      ],
      "future_requirements_due": [
        "id_verification"
      ],
      "endorsements": [
        {
          "name": "base",
          "status": "approved"
        },
        {
          "name": "sepa",
          "status": "approved"
        }
      ],
      "beneficial_owners": [
        {
          "id": "bo_1",
          "email": "bo_1@bizcorp.com"
        },
        {
          "id": "bo_2",
          "email": "bo_2@bizcorp.com"
        }
      ],
      "created_at": "2020-01-01T00:00:00.000Z",
      "updated_at": "2020-01-02T00:00:00.000Z"
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
starting_after
string

This is a customer id. If this is specified, the next page that starts with a customer right AFTER the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers older than the specified customer id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

This is a customer id. If this is specified, the previous page that ends with a customer right BEFORE the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers newer than the specified customer id will be returned (shouldn't be set if starting_after is set)

​
limit
integer

The number of items to return (default of 10, max of 100)

Response

200
application/json

List of customers (the returned list is empty if none found)

The response is of type object.