BRbridge
Customers

Get all customers

Changed on

Get the full list of all customers created on Bridge

get/customers

Request

  • Base URL
    https://api.bridge.xyz/v0
  • URL
    https://api.bridge.xyz/v0/customers
  • Auth
    API key in header Api-Key

Query parameters

starting_afterstring

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_beforestring

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)

limitinteger

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

emailstring

If included, filters to customers with the given email

Response

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

countinteger required

total number of items in data

Changes

  • a390532e9fc6Revision changes
    • warning

      added the new deposits_restricted enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status