API Documentation

API Endpoint

Pages

Pages

Supported filter params

  • creator_id

  • edited_at

  • id

  • project_id (array)

Supported sort params

  • created_at

  • creator_name

  • edited_at

  • project

  • title

  • updated_at


Update action disclaimer:

For a successful page update, it’s best to ensure no user has that page open in the application. Otherwise, the update might not make any changes to the page.

GET /api/v2/pages
Requestsreturns pages

GET  /api/v2/pages?filter[project_id]=1760

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "98",
      "type": "pages",
      "attributes": {
        "cover_image_meta": null,
        "cover_image_url": null,
        "created_at": "2026-01-26T05:19:50.398+01:00",
        "custom_fields": null,
        "edited_at": null,
        "icon_id": null,
        "position": null,
        "preferences": {},
        "title": "Page title 90",
        "updated_at": "2026-01-26T05:19:50.405+01:00",
        "version_number": null,
        "last_activity_at": "2026-01-26T05:19:50.398+01:00",
        "public_access": false,
        "public_uuid": "b1ab5a17-5f95-5e3a-8547-1a98f68a67f9",
        "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
        "parent_page_id": null,
        "root_page_id": null,
        "public": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2308"
          }
        },
        "creator": {
          "meta": {
            "included": false
          }
        },
        "project": {
          "meta": {
            "included": false
          }
        },
        "parent_page": {
          "meta": {
            "included": false
          }
        },
        "root_page": {
          "meta": {
            "included": false
          }
        },
        "attachments": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/pages?filter%5Bproject_id%5D=1760&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/pages?filter%5Bproject_id%5D=1760&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get pages
GET/api/v2/pages

GET /api/v2/pages/1
Requestsreturns page

GET  /api/v2/pages/99

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "99",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:50.505+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 91",
      "updated_at": "2026-01-26T05:19:50.512+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:50.505+01:00",
      "public_access": false,
      "public_uuid": "192b20a5-22e6-58f4-a66a-e5a2c7a396a6",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2309"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a page
GET/api/v2/pages/{id}

URI Parameters
HideShow
id
number (required) Example: 1

page id

POST /api/v2/pages
Requestscreates pagecreates page on global docreturns errorcreates page with version number

POST  /api/v2/pages

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "title": "test name",
      "body": "test body"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "1764"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "102",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:50.965+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:50.964+01:00",
      "icon_id": null,
      "position": null,
      "preferences": null,
      "title": "test name",
      "updated_at": "2026-01-26T05:19:50.971+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:50.965+01:00",
      "public_access": false,
      "public_uuid": "c105ca05-1868-5ad2-a439-acd90327f1f8",
      "body": "",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2312"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/pages

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "title": "test name",
      "body": "test body",
      "root_page_id": "103",
      "parent_page_id": "103"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "104",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:51.062+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:51.062+01:00",
      "icon_id": null,
      "position": null,
      "preferences": null,
      "title": "test name",
      "updated_at": "2026-01-26T05:19:51.062+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:51.062+01:00",
      "public_access": false,
      "public_uuid": null,
      "body": "",
      "parent_page_id": 103,
      "root_page_id": 103,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2313"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/pages

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "parent_page_id": 106
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "parent_page_id and root_page_id must both be present or both be absent",
      "source": {
        "pointer": "data/attributes/base"
      }
    }
  ]
}

POST  /api/v2/pages

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "title": "test name",
      "body": "test body",
      "version_number": "1"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "107",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:51.532+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:51.532+01:00",
      "icon_id": null,
      "position": null,
      "preferences": null,
      "title": "test name",
      "updated_at": "2026-01-26T05:19:51.534+01:00",
      "version_number": 1,
      "last_activity_at": "2026-01-26T05:19:51.532+01:00",
      "public_access": false,
      "public_uuid": "f88c2991-9098-5a32-bcd1-5b8aa827ca58",
      "body": "",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2316"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create a page
POST/api/v2/pages

URI Parameters
HideShow
title
string (required) Example: Title

title

project_id
number (optional) Example: 1

project id

root_page_id
number (optional) Example: 1

id of the root doc (top-level page in the hierarchy).

parent_page_id
number (optional) Example: 1

id of the direct parent page (first level above this page).

PATCH /api/v2/pages/1/move
Requestsmoves doc under target docmoves subpage under target docmoves subpage under target subpagereturns error when target doc id is not present

PATCH  /api/v2/pages/112/move

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "target_doc_id": "111"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "112",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:51.882+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": 1,
      "preferences": {},
      "title": "Page title 98",
      "updated_at": "2026-01-26T05:19:51.929+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:51.882+01:00",
      "public_access": false,
      "public_uuid": "b729c6a5-76eb-5d3a-ada9-9106db792e3f",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": 111,
      "root_page_id": 111,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2321"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/pages/115/move

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "target_doc_id": "113"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "115",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:52.039+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": 1,
      "preferences": {},
      "title": "Page title 101",
      "updated_at": "2026-01-26T05:19:52.064+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:52.039+01:00",
      "public_access": false,
      "public_uuid": null,
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": 113,
      "root_page_id": 113,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2322"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/pages/118/move

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "target_doc_id": "119"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "118",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:52.174+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": 1,
      "preferences": {},
      "title": "Page title 104",
      "updated_at": "2026-01-26T05:19:52.216+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:52.174+01:00",
      "public_access": false,
      "public_uuid": null,
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": 119,
      "root_page_id": 116,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2323"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/pages/121/move

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "target_doc_id": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/target_doc_id"
      }
    }
  ]
}

Moves a page
PATCH/api/v2/pages/{id}/move

URI Parameters
HideShow
id
number (required) Example: 1

page id

target_doc_id
number (required) Example: 1

target doc id

PATCH /api/v2/pages/1
Requestsupdates page when params are valid

PATCH  /api/v2/pages/128

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "title": "new title"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "128",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:52.851+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:52.877+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "new title",
      "updated_at": "2026-01-26T05:19:52.878+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:52.851+01:00",
      "public_access": false,
      "public_uuid": "c7d74420-95eb-5303-a186-90cb809c4d39",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2327"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a page
PATCH/api/v2/pages/{id}

URI Parameters
HideShow
id
number (required) Example: 1

page id

DELETE /api/v2/pages/1
Requestssoft deletes the page

DELETE  /api/v2/pages/132

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a page
DELETE/api/v2/pages/{id}

URI Parameters
HideShow
id
number (required) Example: 1

page id

POST /api/v2/pages/copy
Requestscopies pagecopies page with optional paramsreturns error

POST  /api/v2/pages/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "template_id": 133
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "134",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:53.371+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:53.370+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Copy of Page title 119",
      "updated_at": "2026-01-26T05:19:53.374+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:53.345+01:00",
      "public_access": false,
      "public_uuid": "4d72f422-a158-509b-b404-869adb9ec0f9",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2331"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/pages/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "template_id": 135,
      "title": "new page title",
      "project_id": 1782
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "136",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:53.619+01:00",
      "custom_fields": null,
      "edited_at": "2026-01-26T05:19:53.618+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "new page title",
      "updated_at": "2026-01-26T05:19:53.626+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:53.450+01:00",
      "public_access": false,
      "public_uuid": "d6d4e033-0950-5e0b-8cd6-224e6ed3a226",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2332"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/pages/copy

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "pages",
    "attributes": {
      "template_id": 137
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/template_id"
      }
    }
  ]
}

Copies a page
POST/api/v2/pages/copy

URI Parameters
HideShow
title
string (optional) Example: Title

title

template_id
number (required) Example: 1

id of the page to be copied

PATCH /api/v2/pages/1/publish
Requestspublishes pagereturns error when page on a template

PATCH  /api/v2/pages/138/publish

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "138",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:53.829+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 122",
      "updated_at": "2026-01-26T05:19:53.853+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:53.829+01:00",
      "public_access": true,
      "public_uuid": "bbac1354-7bb4-5fb4-8c70-13264a36d76b",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": true
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2334"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/pages/139/publish

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses409
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "409",
      "code": "cannot_publish_doc_on_template",
      "title": "Conflict error",
      "source": {}
    }
  ]
}

Publishes a page
PATCH/api/v2/pages/{id}/publish

URI Parameters
HideShow
id
number (required) Example: 1

page id

PATCH /api/v2/pages/1/unpublish
Requestsunpublishes pagereturns error when page on a template

PATCH  /api/v2/pages/140/unpublish

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "140",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2026-01-26T05:19:54.027+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 124",
      "updated_at": "2026-01-26T05:19:54.051+01:00",
      "version_number": null,
      "last_activity_at": "2026-01-26T05:19:54.027+01:00",
      "public_access": false,
      "public_uuid": "7ad8f5ab-41a7-56c0-b1b8-bc3e5d52499a",
      "body": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\"}]}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2336"
        }
      },
      "creator": {
        "meta": {
          "included": false
        }
      },
      "project": {
        "meta": {
          "included": false
        }
      },
      "parent_page": {
        "meta": {
          "included": false
        }
      },
      "root_page": {
        "meta": {
          "included": false
        }
      },
      "attachments": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/pages/141/unpublish

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses409
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "409",
      "code": "cannot_unpublish_doc_on_template",
      "title": "Conflict error",
      "source": {}
    }
  ]
}

Unpublishes a page
PATCH/api/v2/pages/{id}/unpublish

URI Parameters
HideShow
id
number (required) Example: 1

page id

Generated by aglio on 26 Jan 2026