Get All

Beta

GET

/metadata-schemas/v1

GET

/metadata-schemas/v1

$ curl https://pre-api.joincandidhealth.com/metadata-schemas/v1 \
>      -H "Authorization: Bearer <token>"

1 {
2   "items": [
3     {
4       "deactivated": true,
5       "fields": [
6         {
7           "key": "key",
8           "type": "STRING",
9           "enum_values": [
10             "enum_values",
11             "enum_values"
12           ]
13         },
14         {
15           "key": "key",
16           "type": "STRING",
17           "enum_values": [
18             "enum_values",
19             "enum_values"
20           ]
21         }
22       ],
23       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
24       "name": "name",
25       "organization_id": "organization_id",
26       "updated_at": "2024-01-15T09:30:00Z",
27       "updating_user_id": "updating_user_id",
28       "version": 1,
29       "description": "description"
30     },
31     {
32       "deactivated": true,
33       "fields": [
34         {
35           "key": "key",
36           "type": "STRING",
37           "enum_values": [
38             "enum_values",
39             "enum_values"
40           ]
41         },
42         {
43           "key": "key",
44           "type": "STRING",
45           "enum_values": [
46             "enum_values",
47             "enum_values"
48           ]
49         }
50       ],
51       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
52       "name": "name",
53       "organization_id": "organization_id",
54       "updated_at": "2024-01-15T09:30:00Z",
55       "updating_user_id": "updating_user_id",
56       "version": 1,
57       "description": "description"
58     }
59   ],
60   "total": 1,
61   "next_page_token": "next_page_token",
62   "prev_page_token": "prev_page_token"
63 }

Gets all custom metadata schemas for the organization, ordered by name. Defaults to page size of 100.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

filtersstringOptional

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ‘path:operator:value’. Example: ‘patient.mrn|eq|12345’. Filters are separated by commas. Example: ‘patient.mrn|eq|12345,appointment.startDate|gt|67890’. All filters are ANDed together. Valid operators are ‘eq’, ‘gt’, ‘lt’, ‘contains’, ‘ieq’, ‘in’. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., ‘patient.id|in|foo;bar;baz’). Path values are camelCase.

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form 'path:operator:value'. Example: 'patient.mrn|eq|12345'. Filters are separated by commas. Example: 'patient.mrn|eq|12345,appointment.startDate|gt|67890'. All filters are ANDed together. Valid operators are 'eq', 'gt', 'lt', 'contains', 'ieq', 'in'. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., 'patient.id|in|foo;bar;baz'). Path values are camelCase.

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

Errors

400

Bad Request Error