API ReferenceProviders

List providers

List all providers that belong to the account.

GET
/v1/providers

Authorization

authorization
AuthorizationBearer <token>

In: header

Query Parameters

page?integer

Page number

Range1 <= value
page_size?integer

Number of items per page

Range1 <= value
search?string

Only return providers that match the search query (name or email).

metadata?

Filter providers by metadata using bracket notation. See Metadata Filtering for more details.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/providers"
{  "data": [    {      "created_at": "2017-09-12T12:34:55Z",      "display_name": "John Smith",      "email": "john@example.com",      "first_name": "John",      "id": "prov_d025a96ac0c6",      "last_name": "Smith",      "metadata": {        "external_id": "123"      },      "object": "provider",      "time_zone": "America/New_York",      "updated_at": "2017-09-13T10:11:12Z"    }  ],  "meta": {    "current_page": 1,    "page_size": 10,    "total_count": 50,    "total_pages": 5  }}