Containers

List containers

GET /api/v1/containers

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`status`	query	string (backlog, new, next_up, active, future, completed, cancelled, on_hold)	No	—
`priority`	query	string (none, low, medium, high, urgent)	No	—
`limit`	query	integer	No	—
`includeContent`	query	boolean	No	When true, each item includes Lexical `content` and `inboxContent` (large). Default omits them for smaller list payloads.
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/containers?organisationId=<organisationId>&status=<status>&priority=<priority>&limit=<limit>&includeContent=<includeContent>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "priority": "none",
      "status": "backlog",
      "heroImageUrl": "string",
      "reviewDate": 0,
      "timelineDate": 0,
      "orgAccess": "all",
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "sharedRole": "admin"
    }
  ],
  "nextCursor": "string"
}

Other statuses: 401.

Response body type

{ data: ContainerListItem[]; nextCursor: string }

Create container

POST /api/v1/containers

Example request

curl -X POST \
"https://api.example.com/api/v1/containers" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","priority":"none","status":"backlog","heroImageUrl":"string","content":"string","inboxContent":"string","reviewDate":0,"timelineDate":0,"organisationId":"string","orgAccess":"all"}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "priority": "none",
    "status": "backlog",
    "heroImageUrl": "string",
    "content": "string",
    "inboxContent": "string",
    "reviewDate": 0,
    "timelineDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Other statuses: 400, 401.

Response body type

{ data: Container }

Get container by id

GET /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`includeZones`	query	boolean	No	—
`includeActions`	query	boolean	No	—
`includeMasterPages`	query	boolean	No	Include master documents for this container.
`includePages`	query	boolean	No	—
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/containers/<id>?includeZones=<includeZones>&includeActions=<includeActions>&includeMasterPages=<includeMasterPages>&includePages=<includePages>&organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "priority": "none",
    "status": "backlog",
    "heroImageUrl": "string",
    "content": "string",
    "inboxContent": "string",
    "reviewDate": 0,
    "timelineDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Container }

Update container

PATCH /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X PATCH \
"https://api.example.com/api/v1/containers/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","priority":"none","status":"backlog","heroImageUrl":"string","content":"string","inboxContent":"string","reviewDate":0,"timelineDate":0}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "priority": "none",
    "status": "backlog",
    "heroImageUrl": "string",
    "content": "string",
    "inboxContent": "string",
    "reviewDate": 0,
    "timelineDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0
  }
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Container }

Delete container

DELETE /api/v1/containers/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`organisationId`	query	string	No	—

Example request

curl -X DELETE \
"https://api.example.com/api/v1/containers/<id>?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Other statuses: 401, 403, 404.

Response body type

—

List pages linked to container

GET /api/v1/containers/{id}/pages

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`organisationId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/containers/<id>/pages?organisationId=<organisationId>&limit=<limit>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "nextCursor": "string"
}

Response body type

{ data: PageMeta[]; nextCursor: string }

Link page to container

POST /api/v1/containers/{id}/pages/link

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`organisationId`	query	string	No	—

Example request

curl -X POST \
"https://api.example.com/api/v1/containers/<id>/pages/link?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"pageId":"string"}'

Response body type

—

Unlink page from container

POST /api/v1/containers/{id}/pages/unlink

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X POST \
"https://api.example.com/api/v1/containers/<id>/pages/unlink" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"pageId":"string"}'

Response body type

—

Types that have at least one master document in this container

GET /api/v1/containers/{id}/master-document-types

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/containers/<id>/master-document-types?organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

List master documents for a container and document type

GET /api/v1/containers/{id}/master-documents

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.
`masterDocumentTypeId`	query	string	Yes	—
`organisationId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/containers/<id>/master-documents?masterDocumentTypeId=<masterDocumentTypeId>&organisationId=<organisationId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Create master document (body or fromTemplate)

POST /api/v1/containers/{id}/master-documents

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X POST \
"https://api.example.com/api/v1/containers/<id>/master-documents" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"masterDocumentTypeId":"string","name":"string","body":"string","organisationId":"string"}'

Response body type

—