API Reference

Get M2M clients with pagination

get
https://project-api.zapehr.com/v1/m2m/v2/list

Get M2M clients in the Project with pagination, sort, sort order and filtering. M2M Clients are used to access Oystehr APIs from scripts and server-side code like Zambda Functions.

Access Policy Action: App:ListAllM2MClients
Access Policy Resource: IAM:M2MClient

Query Params
string

Filter M2M clients by name.

uuid

Filter M2M clients by id

string

Filter M2M clients by profile. Expected format: 'FhirResource/UUID'.

uuid

Filter M2M clients by role UUID.

string

Cursor for pagination to fetch next set of M2M clients.

integer
1 to 100
Defaults to 25

Maximum number of M2M clients to return per query.

string
enum
Defaults to createdAt

Field to sort the M2M clients by.

Allowed:
string
enum
Defaults to asc

Order of sorting (ASC or DESC).

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago