Retrieve an existing type by its path.

get

https://example.com/authoring/v1/types/by-path

Use the /types/by-path 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…

Query Params

path

string

required

The path of the content type to retrieve.

fields

string

A comma separated list that when specified, limits the fields returned to just those specified. Any type document field is a valid value.

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 is returned when using If-None-Match header and the value matches the latest version of the item.

200Success.

400Invalid path OR Invalid input.

403The operation is not available based on the current tenant's tier.

404The document with path {path} was not found OR 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.