Skip to main content
GET
/
documentations
List Documentations
curl --request GET \
  --url https://api.contextone.com/documentations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Org-Id: <x-org-id>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "indexType": "crawl",
      "urls": [
        "<string>"
      ],
      "excludeUrls": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "versions": [
        {
          "id": 123,
          "repositoryId": "<string>",
          "documentationId": "<string>",
          "version": {
            "type": "release",
            "name": "<string>",
            "commitId": "<string>",
            "date": "2023-11-07T05:31:56Z"
          },
          "status": "COMPLETED",
          "namespace": "<string>",
          "taskRunId": "<string>",
          "output": "<string>",
          "error": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Org-Id
string
required

Organization ID (required)

Response

200 - application/json

Documentations list

success
boolean
required
data
object[]
required
I