API reference
Help centerCommunityDevelopersAcademyStatus
Start typing to search…

Retrieve all element definitions in the database.

get https://example.com/authoring/v1/elementdefs

Use the /elementdefs endpoint to retrieve all element definitions from the database.

Each element definition describes a variety of element that can be added to a content type.

To programmatically create a content-type, merge the 'elementFragment' attribute into the 'elements' attribute of the type, performing the following replacements:
'$ELEMENT_KEY$': With the desired element key
'$ELEMENT_LABEL$': With the desired element label

User roles: admin, manager, editor, viewer

Log in to see full request history
Query Params
number
Defaults to 0

Use the offset parameter to specify the number of element definitions to skip and return the rest.

number
Defaults to 50

Set the limit for the number of element definitions that are returned.

string
Defaults to ascending

Specify whether you want the element definitions to be returned in ascending or descending order.

string

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

string

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

  • links: Adds the 'links' section (see '#/definitions/DocumentLinks') 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.

Responses

Updated over 5 years ago

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 5 years ago