Workspace API: Pages

Retrieves one specific page

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/workspace/pages/{page}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workspace/pages/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "objectId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "pageId": "123e4567-e89b-12d3-a456-426614174000",
  "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "isAccessDenied": true,
  "isHidden": true,
  "isNewTab": true,
  "authorName": "text",
  "contentControl": "text",
  "contentLabels": "text",
  "hook": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "navigateUrl": "text",
  "objectType": "text",
  "pageIcon": "text",
  "pageSlug": "text",
  "pageType": "text",
  "title": "text",
  "sequence": 1,
  "authorDate": "2026-01-29T17:47:51.197Z",
  "lastChangeTime": "2026-01-29T17:47:51.197Z"
}

Checks for the existence of one specific page

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pagestring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workspace/pages/{page}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workspace/pages/{page} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

objectIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

parentPageIdstring · uuid · nullableOptional

siteIdstring · uuid · nullableOptional

isAccessDeniedboolean · nullableOptional

isHiddenboolean · nullableOptional

isNewTabboolean · nullableOptional

authorNamestring · nullableOptional

contentControlstring · nullableOptional

contentLabelsstring · nullableOptional

hookstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

navigateUrlstring · nullableOptional

objectTypestring · nullableOptional

pageIconstring · nullableOptional

pageSlugstring · nullableOptional

pageTypestring · nullableOptional

titlestring · nullableOptional

sequenceinteger · int32 · nullableOptional

authorDatestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

isNullNavigateUrlboolean · nullableOptional

parentPageSlugstring · nullableOptional

parentPageTypestring · nullableOptional

siteDomainstring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/pages/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/pages/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1131

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:51.197Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "objectId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "isAccessDenied": true,
  "isHidden": true,
  "isNewTab": true,
  "authorName": "text",
  "contentControl": "text",
  "contentLabels": "text",
  "hook": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "navigateUrl": "text",
  "objectType": "text",
  "pageIcon": "text",
  "pageSlug": "text",
  "pageType": "text",
  "title": "text",
  "sequence": 1,
  "authorDate": "2026-01-29T17:47:51.197Z",
  "lastChangeTime": "2026-01-29T17:47:51.197Z",
  "isNullNavigateUrl": true,
  "parentPageSlug": "text",
  "parentPageType": "text",
  "siteDomain": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "objectId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "pageId": "123e4567-e89b-12d3-a456-426614174000",
    "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
    "siteId": "123e4567-e89b-12d3-a456-426614174000",
    "isAccessDenied": true,
    "isHidden": true,
    "isNewTab": true,
    "authorName": "text",
    "contentControl": "text",
    "contentLabels": "text",
    "hook": "text",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "navigateUrl": "text",
    "objectType": "text",
    "pageIcon": "text",
    "pageSlug": "text",
    "pageType": "text",
    "title": "text",
    "sequence": 1,
    "authorDate": "2026-01-29T17:47:51.197Z",
    "lastChangeTime": "2026-01-29T17:47:51.197Z"
  }
]

Counts the pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

objectIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

parentPageIdstring · uuid · nullableOptional

siteIdstring · uuid · nullableOptional

isAccessDeniedboolean · nullableOptional

isHiddenboolean · nullableOptional

isNewTabboolean · nullableOptional

authorNamestring · nullableOptional

contentControlstring · nullableOptional

contentLabelsstring · nullableOptional

hookstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

navigateUrlstring · nullableOptional

objectTypestring · nullableOptional

pageIconstring · nullableOptional

pageSlugstring · nullableOptional

pageTypestring · nullableOptional

titlestring · nullableOptional

sequenceinteger · int32 · nullableOptional

authorDatestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

isNullNavigateUrlboolean · nullableOptional

parentPageSlugstring · nullableOptional

parentPageTypestring · nullableOptional

siteDomainstring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/pages/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/pages/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1131

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:51.197Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "objectId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "isAccessDenied": true,
  "isHidden": true,
  "isNewTab": true,
  "authorName": "text",
  "contentControl": "text",
  "contentLabels": "text",
  "hook": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "navigateUrl": "text",
  "objectType": "text",
  "pageIcon": "text",
  "pageSlug": "text",
  "pageType": "text",
  "title": "text",
  "sequence": 1,
  "authorDate": "2026-01-29T17:47:51.197Z",
  "lastChangeTime": "2026-01-29T17:47:51.197Z",
  "isNullNavigateUrl": true,
  "parentPageSlug": "text",
  "parentPageType": "text",
  "siteDomain": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

objectIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

parentPageIdstring · uuid · nullableOptional

siteIdstring · uuid · nullableOptional

isAccessDeniedboolean · nullableOptional

isHiddenboolean · nullableOptional

isNewTabboolean · nullableOptional

authorNamestring · nullableOptional

contentControlstring · nullableOptional

contentLabelsstring · nullableOptional

hookstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

navigateUrlstring · nullableOptional

objectTypestring · nullableOptional

pageIconstring · nullableOptional

pageSlugstring · nullableOptional

pageTypestring · nullableOptional

titlestring · nullableOptional

sequenceinteger · int32 · nullableOptional

authorDatestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

isNullNavigateUrlboolean · nullableOptional

parentPageSlugstring · nullableOptional

parentPageTypestring · nullableOptional

siteDomainstring · nullableOptional

Responses

200

OK

No content

post

/api/workspace/pages/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/pages/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1131

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:51.197Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "objectId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "isAccessDenied": true,
  "isHidden": true,
  "isNewTab": true,
  "authorName": "text",
  "contentControl": "text",
  "contentLabels": "text",
  "hook": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "navigateUrl": "text",
  "objectType": "text",
  "pageIcon": "text",
  "pageSlug": "text",
  "pageType": "text",
  "title": "text",
  "sequence": 1,
  "authorDate": "2026-01-29T17:47:51.197Z",
  "lastChangeTime": "2026-01-29T17:47:51.197Z",
  "isNullNavigateUrl": true,
  "parentPageSlug": "text",
  "parentPageType": "text",
  "siteDomain": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of pages that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

objectIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

parentPageIdstring · uuid · nullableOptional

siteIdstring · uuid · nullableOptional

isAccessDeniedboolean · nullableOptional

isHiddenboolean · nullableOptional

isNewTabboolean · nullableOptional

authorNamestring · nullableOptional

contentControlstring · nullableOptional

contentLabelsstring · nullableOptional

hookstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

navigateUrlstring · nullableOptional

objectTypestring · nullableOptional

pageIconstring · nullableOptional

pageSlugstring · nullableOptional

pageTypestring · nullableOptional

titlestring · nullableOptional

sequenceinteger · int32 · nullableOptional

authorDatestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

isNullNavigateUrlboolean · nullableOptional

parentPageSlugstring · nullableOptional

parentPageTypestring · nullableOptional

siteDomainstring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/pages/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/pages/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1131

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:51.197Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "objectId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentPageId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "isAccessDenied": true,
  "isHidden": true,
  "isNewTab": true,
  "authorName": "text",
  "contentControl": "text",
  "contentLabels": "text",
  "hook": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "navigateUrl": "text",
  "objectType": "text",
  "pageIcon": "text",
  "pageSlug": "text",
  "pageType": "text",
  "title": "text",
  "sequence": 1,
  "authorDate": "2026-01-29T17:47:51.197Z",
  "lastChangeTime": "2026-01-29T17:47:51.197Z",
  "isNullNavigateUrl": true,
  "parentPageSlug": "text",
  "parentPageType": "text",
  "siteDomain": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "pageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "pageIcon": "text",
    "pageTitle": "text",
    "pageUrl": "text"
  }
]