List All Active Insurer Clients

GET 
/v1/clients

Get list of active insurer clients. Note: This feature is only available to HMOs/Insurers.

Request

Query Parameters

page integer

The presence of this param would return results in paginated format Better used together with the 'per_page' param

This is used to indicate the offset from which results are fetched in paginated format.

per_page integer

Better used together with the 'page' param

This is used to indicate the how many results are to be in an offset for pagination.

Responses

200

Success

application/json

Schema

Schema

page integer
per_page integer
total integer
data object[]
Array [
id integer
name string
address string
phone string
email string
is_active integer
The status of the client where 1 is active.
valid_until string
]

Example (from schema)

{
  "page": 0,
  "per_page": 0,
  "total": 0,
  "data": [
    {
      "id": 0,
      "name": "string",
      "address": "string",
      "phone": "string",
      "email": "string",
      "is_active": 1,
      "valid_until": "string"
    }
  ]
}

401

Unauthenticated

403

Forbidden

404

Not Found

Loading...