List document history

GET

/api/v1/collab/history/{item_id}

const url = 'https://example.com/api/v1/collab/history/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/collab/history/example \
  --header 'Authorization: Bearer <token>'

List the owner’s durable Note or Canvas history with bounded cursor paging. Shared recipients cannot read the owner’s history. Route: /api/v1/collab/history/{item_id}. Inputs: item_id, after, before, limit. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

item_id

required

string

Stable item ID

Query Parameters

after

integer format: int64

Continue after this monotonic point ID.

before

integer format: int64

Read a newest-first page strictly before this point (zero starts at head).

limit

integer format: int32

Number of history points to return, from 1 through 100.

Responses

200

History points

application/json

object

next_after

Last returned point ID when another page may exist.

integer | null format: int64

points

required

Points in ascending ID order.

Array<object>

object

at_ms

required

Server time in Unix milliseconds.

integer format: int64

author

required

One of:

A signed-in User.

object

required

A signed-in User.

string

kind

required

string

Allowed values: user

bytes

required

Encoded and compressed bytes for this point.

integer format: int32

required

Stable history point ID.

integer format: int64

Example

{
  "points": [
    {
      "author": {
        "kind": "user"
      }
    }
  ]
}

400

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}

401

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}

403

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}

404

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}

503

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}