Skip to main content
GET
/
documents
List Documents
curl --request GET \
  --url https://getunblocked.com/api/v1/documents \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "title": "Password Reset Guide",
    "uri": "https://my.company.com/apollo/ticket/123456"
  }
]

Authorizations

​
Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Query Parameters

​
limit
integer<int32>

Limit used to constrain results of list operations. When not specified a default limit of 25 is used.

A maximum limit is applied to the results, so the server may respond with fewer results than requested; clients must not use this as a signal that this is the final page of results.

Required range: 1 <= x <= 200
​
after
string

Opaque cursor to be used for paging in a forward or backward direction. Cursors are stateless and so they never expire.

Required string length: 1 - 10000
​
before
string

Opaque cursor to be used for paging in a forward or backward direction. Cursors are stateless and so they never expire.

Required string length: 1 - 10000

Response

OK

​
id
string<uuid>
required

The ID of the document.

​
collectionId
string<uuid>
required

The ID of the collection to which the document should be added.

​
createdAt
string<date-time>
required

The date and time the document was first added.

​
updatedAt
string<date-time>
required

The date and time the document was last updated.

​
title
string
required

A short title for the document in plain text.

Example:

"Password Reset Guide"

​
uri
string
required

A URL of the original source document that uniquely identifies the document. These will be used in answer references to link to the original source.

Example:

"https://my.company.com/apollo/ticket/123456"