Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring image profiles

Retrieve all image profiles in the database.

Use the /image-profiles endpoint to retrieve all image profiles from the database.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/image-profiles

Query parameters

offsetnumber

Use the offset parameter to specify the number of image profiles to skip and return the rest.

limitnumber

Set the limit for the number of image profiles that are returned.

format'feed' | 'array' | 'sequence'

Specify the result format.

  • feed - (default) returns a wrapper with links
  • array - returns just the array of results
  • sequence - each result is a separate JSON document on a new line
pageMode'offset' | 'deep'

Specify the next and previous page link mode.

  • offset - (default) allows paging forward or backwards, but only a small number of times
  • deep - uses index keys to efficiently page through a large result set, but only in one direction
order'ascending' | 'descending'

Specify whether you want the image profiles to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order.

fieldsstring

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

includestring

Specifies additional fields to include with each result. Valid options are: * 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.

Response

Success.

offsetinteger

number of results to skip.

limitinteger

number of results to return.

hrefstring

the url of the current query.

nextstring

the url for the next page of results. Only present if there are more results.

previousstring

the url for the previous page of results. Not present when on the first page.

Example response

{
  "items": [
    {
      "tags": [
        "news",
        "sample"
      ]
    }
  ]
}