ProvidersResponse

Response schema for multiple providers

data object[]required

The providers details

Array [

created_atstring<date-time>required

Time at which the object was created.

display_namestringrequired

The provider's display name.

first_namestringrequired

The provider's first name.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^prov_\w{12}$

last_namestringrequired

The provider's last name.

metadataobject

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

objectstringrequired

String representing the object's type.

Possible values: [provider]

updated_atstring<date-time>required

Time at which the object was last updated.

]

meta objectrequired

Metadata for paginated responses

current_pageintegerrequired

Current page number

page_sizeintegerrequired

Number of records per page

total_countintegerrequired

Total number of records

total_pagesintegerrequired

Total number of pages

ProvidersResponse

{
  "data": [
    {
      "created_at": "2017-09-12T12:34:55Z",
      "display_name": "John Smith",
      "first_name": "John",
      "id": "prov_d025a96ac0c6",
      "last_name": "Smith",
      "metadata": {
        "external_id": "123"
      },
      "object": "provider",
      "updated_at": "2017-09-13T10:11:12Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "page_size": 10,
    "total_count": 50,
    "total_pages": 5
  }
}