Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferenceCustom SchemasV1

Get all custom schemas

Beta
GET
/api/custom-schemas/v1
GET
/api/custom-schemas/v1
1curl https://api.joincandidhealth.com/api/custom-schemas/v1 \
2     -H "Authorization: Bearer <token>"
Try it
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}
Returns all custom schemas.
Was this page helpful?
Previous

Get custom schema

Next
Built with
Get custom schema
Returns all custom schemas.

Authentication

AuthorizationBearer
OAuth authentication of the form `<token>`.

Response

This endpoint returns an object.
schemaslist of objects

Errors

OAuth authentication of the form <token>.