Get

Beta

GET

/metadata-schemas/v1/:id

Gets a custom metadata schema by MetadataSchemaId.

AuthorizationBearer

OAuth authentication of the form <token>.

idUUIDRequired

The unique identifier for a custom MetadataSchema.

This endpoint returns an object.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

fieldslist of objects

idUUID

The unique identifier for a custom MetadataSchema.

namestring

organization_idstring

The organization that owns this object.

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

descriptionstringOptional

1	{
2	"deactivated": true,
3	"fields": [
4	{
5	"key": "key",
6	"type": "STRING",
7	"enum_values": [
8	"enum_values",
9	"enum_values"
10	]
11	},
12	{
13	"key": "key",
14	"type": "STRING",
15	"enum_values": [
16	"enum_values",
17	"enum_values"
18	]
19	}
20	],
21	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22	"name": "name",
23	"organization_id": "organization_id",
24	"updated_at": "2024-01-15T09:30:00Z",
25	"updating_user_id": "updating_user_id",
26	"version": 1,
27	"description": "description"
28	}

$	curl https://pre-api.joincandidhealth.com/metadata-schemas/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
>	-H "Authorization: Bearer <token>"