Entities

List entities

List built-in actors, products, visual styles, and slideshow themes, followed by the entities available to your team. Built-in entities have isBuiltIn: true and cannot be updated or archived. Cursor-paginated; see the Pagination guide.

get/v1/entities

Query parameters

entityType'ACTOR' | 'PRODUCT' | 'VISUAL_STYLE' | 'SLIDESHOW_THEME'

When provided, returns only entities of this type. Omit to return all entities.

limitinteger

Maximum number of items to return in the page. Defaults to 50; capped at 200. See Pagination.

cursorstring

Opaque pagination cursor returned as nextCursor by the previous page. Omit on the first request. Cursors are tied to the endpoint that produced them and must be passed unmodified. See Pagination.

Response

Entity list

hasMoreboolean required

When true, there are more entities available. Pass nextCursor as the cursor query param to fetch the next page.

nextCursorstring nullable required

Opaque cursor to fetch the next page. null when hasMore is false.

Changes

No recorded changes to this endpoint across all 1 revision of this API.