Client - API Endpoints

GET/contents/documents

Authorization

bearer

Query parameters

Response

200401

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/contents/documents', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401

{
  "statusCode": 200,
  "data": {
    "documents": [
      {
        "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
        "title": "Privacy Policy",
        "name": "privacyPolicy",
        "iconName": "book-open",
        "content": "https://www.helloiconic.com/privacy-policy",
        "format": "url",
        "isPublic": false,
        "expiresAt": "2022-12-07T17:21:27.548Z"
      }
    ]
  }
}

GET/contents/documents/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Response

200400401404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/contents/documents/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200,
  "data": {
    "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
    "title": "Privacy Policy",
    "name": "privacyPolicy",
    "iconName": "book-open",
    "content": "https://www.helloiconic.com/privacy-policy",
    "format": "url",
    "isPublic": false,
    "expiresAt": "2022-12-07T17:21:27.548Z"
  }
}

GET/contents/document-categories

Authorization

bearer

Response

200401

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/contents/document-categories', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401

{
  "statusCode": 200,
  "data": {
    "documentCategories": [
      {
        "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
        "name": "settings"
      }
    ]
  }
}

GET/contents/document-categories/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Response

200400401404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/contents/document-categories/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404

{
  "statusCode": 200,
  "data": {
    "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
    "name": "settings"
  }
}

GET/contents/public-documents

Query parameters

Response

200

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/contents/public-documents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "statusCode": 200,
  "data": {
    "documents": [
      {
        "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
        "title": "Privacy Policy",
        "name": "privacyPolicy",
        "iconName": "book-open",
        "content": "https://www.helloiconic.com/privacy-policy",
        "format": "pdf",
        "isPublic": true
      }
    ]
  }
}

GET/contents/public-documents/{id}

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Response

200400404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/contents/public-documents/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "statusCode": 200,
  "data": {
    "id": "0466770d-4024-457c-92d5-fbe9022ee5b7",
    "title": "Privacy Policy",
    "name": "privacyPolicy",
    "iconName": "book-open",
    "content": "https://www.helloiconic.com/privacy-policy",
    "format": "pdf",
    "isPublic": true
  }
}