Published Paths

List published paths

Changed on

List the organization's published paths.

Required OAuth scope: paths:read

get/v2/published-paths/

Request

Query parameters

page[size]integer

Maximum number of records to return. Values above 100 are served as 100; values below 1 are served as 1.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

filter[domain.id]string nullable

Opaque domain id.

filter[path.id]string nullable

Opaque path id.

filter[is_hidden]boolean nullable

Match the hidden flag.

filter[slug]string nullable

Exact slug match.

includestring nullable

Related resources to include. Supported: path.

Response

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.

Changes