Get custom schema

Beta

GET

/api/custom-schemas/v1/:schema_id

Return a custom schema with a given ID.

AuthorizationBearer

OAuth authentication of the form <token>.

schema_idUUIDRequired

This endpoint returns an object.

idUUID

namestring

fieldslist of objects

descriptionstring or null

1	import uuid
2
3	from candid import CandidApiClient
4
5	client = CandidApiClient(
6	client_id="YOUR_CLIENT_ID",
7	client_secret="YOUR_CLIENT_SECRET",
8	)
9	client.custom_schemas.v_1.get(
10	schema_id=uuid.UUID(
11	"ec096b13-f80a-471d-aaeb-54b021c9d582",
12	),
13	)

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