Retrieve an existing type.

get

https://example.com/authoring/v1/types/{id}

Use the /types/{id} end-point to retrieve an existing content type from the database.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Provide the ID of the content type document that you want to retrieve.

Query Params

fields

string

Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list.

include

string

Specify additional fields to include with each result.
Valid options are:

links: Adds the 'links' section (see '#/definitions/DocumentLinks') to the response.
metadata: Adds additional details such as creator and last modifier to the response.
schema: Adds the 'schema' section to the response.
mappings: Add the 'mappings' section to the response.
all: Adds all current and future additional fields to the response.

When used in-conjunction with the 'fields' option, both the fields that are specified in the 'fields' option and the fields in the 'include' option are returned.

Headers

If-None-Match

string

Provide an Etag value from a previous request to check whether the content type document retrieved is the most recent version. If the content type document is the most recent version, the call returns a 304 ( Not modified) message instead of sending the content type document back.

Responses

304

Not modified. The Etag value that you provided in the If-Match parameter matches the recent document version.

200Successfully retrieved the existing content type document that matches the ID that you provided.

404A content type document with the ID {id} was not found or the current tenant's database is not provisioned.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.