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]=1749

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": "2025-11-24T05:19:05.457+01:00",
        "custom_fields": null,
        "edited_at": null,
        "icon_id": null,
        "position": null,
        "preferences": {},
        "title": "Page title 90",
        "updated_at": "2025-11-24T05:19:05.465+01:00",
        "version_number": null,
        "last_activity_at": "2025-11-24T05:19:05.457+01:00",
        "public_access": false,
        "public_uuid": "b1ab5a17-5f95-5e3a-8547-1a98f68a67f9",
        "body": "{\"text\":\"Page body 98\"}",
        "parent_page_id": null,
        "root_page_id": null,
        "public": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2292"
          }
        },
        "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=1749&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/pages?filter%5Bproject_id%5D=1749&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": "2025-11-24T05:19:05.555+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 91",
      "updated_at": "2025-11-24T05:19:05.562+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:05.555+01:00",
      "public_access": false,
      "public_uuid": "192b20a5-22e6-58f4-a66a-e5a2c7a396a6",
      "body": "{\"text\":\"Page body 99\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2293"
        }
      },
      "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 page and tracks intercom event and planhat activityreturns errorcreates page with version numbermoves, :aggregate_failures docreturns error

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": "1753"
        }
      }
    }
  }
}
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": "2025-11-24T05:19:05.973+01:00",
      "custom_fields": null,
      "edited_at": "2025-11-24T05:19:05.973+01:00",
      "icon_id": null,
      "position": null,
      "preferences": null,
      "title": "test name",
      "updated_at": "2025-11-24T05:19:05.980+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:05.973+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": "2296"
        }
      },
      "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": 103
    }
  }
}
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/parent_page"
      }
    }
  ]
}

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": "104",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:06.203+01:00",
      "custom_fields": null,
      "edited_at": "2025-11-24T05:19:06.203+01:00",
      "icon_id": null,
      "position": null,
      "preferences": null,
      "title": "test name",
      "updated_at": "2025-11-24T05:19:06.206+01:00",
      "version_number": 1,
      "last_activity_at": "2025-11-24T05:19:06.203+01:00",
      "public_access": false,
      "public_uuid": "04932515-0ab8-55f3-8a4d-eb5ff758d651",
      "body": "",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2298"
        }
      },
      "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/109/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": "108"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "109",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:06.574+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": 1,
      "preferences": {},
      "title": "Page title 97",
      "updated_at": "2025-11-24T05:19:06.626+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:06.575+01:00",
      "public_access": false,
      "public_uuid": "8aff8435-998b-5ec1-aa56-bad65919f59a",
      "body": "{\"text\":\"Page body 105\"}",
      "parent_page_id": 108,
      "root_page_id": 108,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2303"
        }
      },
      "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": ""
    }
  }
}
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"
      }
    }
  ]
}

Create a page
POST/api/v2/pages

URI Parameters
HideShow
title
string (required) Example: Title

title

project_id
number (optional) Example: 1

project id

id
number (required) Example: 109
PATCH /api/v2/pages/1
Requestsupdates page when params are valid

PATCH  /api/v2/pages/125

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": "125",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:07.578+01:00",
      "custom_fields": null,
      "edited_at": "2025-11-24T05:19:07.605+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "new title",
      "updated_at": "2025-11-24T05:19:07.606+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:07.578+01:00",
      "public_access": false,
      "public_uuid": "0489ca68-4cca-582c-bc63-b9cb0f59e4bf",
      "body": "{\"text\":\"Page body 121\"}",
      "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": {}
}

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/129

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": 130
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "131",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:08.121+01:00",
      "custom_fields": null,
      "edited_at": "2025-11-24T05:19:08.120+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Copy of Page title 118",
      "updated_at": "2025-11-24T05:19:08.124+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:08.094+01:00",
      "public_access": false,
      "public_uuid": "a0f52364-bb2f-5445-bb93-cf296e9e1e7b",
      "body": "{\"text\":\"Page body 126\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "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/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": 132,
      "title": "new page title",
      "project_id": 1770
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "133",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:08.329+01:00",
      "custom_fields": null,
      "edited_at": "2025-11-24T05:19:08.328+01:00",
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "new page title",
      "updated_at": "2025-11-24T05:19:08.335+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:08.198+01:00",
      "public_access": false,
      "public_uuid": "746b8f14-706c-567e-b8d6-ae84efd4e5b4",
      "body": "{\"text\":\"Page body 127\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2314"
        }
      },
      "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": 134
    }
  }
}
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/135/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": "135",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:08.551+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 121",
      "updated_at": "2025-11-24T05:19:08.578+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:08.551+01:00",
      "public_access": true,
      "public_uuid": "a23b2688-36a3-55de-b472-8693c6e01a13",
      "body": "{\"text\":\"Page body 129\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": true
    },
    "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": {}
}

PATCH  /api/v2/pages/136/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/137/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": "137",
    "type": "pages",
    "attributes": {
      "cover_image_meta": null,
      "cover_image_url": null,
      "created_at": "2025-11-24T05:19:08.779+01:00",
      "custom_fields": null,
      "edited_at": null,
      "icon_id": null,
      "position": null,
      "preferences": {},
      "title": "Page title 123",
      "updated_at": "2025-11-24T05:19:08.805+01:00",
      "version_number": null,
      "last_activity_at": "2025-11-24T05:19:08.779+01:00",
      "public_access": false,
      "public_uuid": "17d2518f-d0c2-5db4-9b53-f34b612698e0",
      "body": "{\"text\":\"Page body 131\"}",
      "parent_page_id": null,
      "root_page_id": null,
      "public": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2318"
        }
      },
      "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/138/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 24 Nov 2025