Clients
Clients and their locations, plus the consumers and locations a client manages in its own portal.
36 operations in 5 areas · Download the OpenAPI document
Clients 9
- GETRetrieve a list of clients
/clients - POSTCreate a new client
/clients - DELETEDelete files associated with a client
/clients/document/files - GETExport clients to Excel
/clients/export - GETGet all clients' names and IDs
/clients/name-list - POSTUpdate an existing client
/clients/{client} - DELETEDelete a client
/clients/{client} - GETRetrieve specific tab details of a client
/clients/{client}/tab/{tab} - GETExport a Client to Excel
/export-client/{client}
Locations 12
- GETRetrieve a list of client locations
/clients/{client}/locations - POSTCreate a new client location
/clients/{client}/locations - POSTUpdate an existing client location
/clients/{client}/locations/{location} - DELETEDelete a client location
/clients/{client}/locations/{location} - GETRetrieve specific tab details of a client location
/clients/{client}/locations/{location}/tab/{tab} - GETRetrieve a list of locations
/locations - DELETEDelete files associated with an client location
/locations/document/files - GETExport locations to Excel
/locations/export - GETGet all locations' names and IDs
/locations/name-list - GETRetrieve all locations for a specific client
/locations/{client} - POSTManage client location reassignment
/reassign-client-locations - PUTSet a default client location
/set-default-client-location/{id}
Consumers in the client portal 8
- GETRetrieve a list of consumers in client portal
/settings/portal/client/consumers - POSTCreate a new consumer in client portal
/settings/portal/client/consumers - GETFind an existing guardian by email (own consumers only)
/settings/portal/client/consumers/guardians/lookup - POSTUpdate an existing consumer in client portal
/settings/portal/client/consumers/{consumer} - DELETEDelete a consumer in client portal
/settings/portal/client/consumers/{consumer} - GETRetrieve specific tab details of a consumer in client portal
/settings/portal/client/consumers/{consumer}/tab/{tab} - GETExport a Consumer in client portal to Excel
/settings/portal/client/export-consumer/{consumer} - GETExport all Consumers in client portal to Excel
/settings/portal/client/export-consumers
Locations in the client portal 5
- GETExport locations to CSV in client portal
/settings/portal/client/export-locations - POSTUpdate an existing client location in client portal
/settings/portal/client/location/{id} - GETRetrieve specific tab details of a client location
/settings/portal/client/location/{id}/tab/{tab} - GETRetrieve a list of client locations
/settings/portal/client/locations - POSTCreate a new location in client portal
/settings/portal/client/locations