Get all custom schemas

Beta

GET

/api/custom-schemas/v1

Returns all custom schemas.

AuthorizationBearer

OAuth authentication of the form <token>.

organization_idUUIDOptional

Filter to a specific organization's schemas. If not provided, defaults to the requesting user's organization.

This endpoint returns an object.

schemaslist of objects

403

Unauthorized Error

1	{
2	"schemas": [
3	{
4	"id": "ec096b13-f80a-471d-aaeb-54b021c9d582",
5	"name": "General Medicine",
6	"fields": [
7	{
8	"key": "provider_category",
9	"type": "STRING"
10	},
11	{
12	"key": "is_urgent_care",
13	"type": "BOOLEAN"
14	},
15	{
16	"key": "bmi",
17	"type": "DOUBLE"
18	},
19	{
20	"key": "age",
21	"type": "INTEGER"
22	}
23	],
24	"description": "Values associated with a generic visit"
25	}
26	]
27	}

1	from candid import CandidApiClient
2
3	client = CandidApiClient()
4
5	client.custom_schemas.v_1.get_multi()