Client - API Endpoints

PreviousDocument NextAdmin - API Endpoints

Last updated 2 years ago

Was this helpful?

get

Authorizations

Query parameters

categoryNamestringOptionalExample: settings

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

get

GET /contents/documents HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "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

Authorizations

Path parameters

idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7

Responses

200

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

404

An error occurred while entering the information

application/json

get

GET /contents/documents/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "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

Authorizations

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

get

GET /contents/document-categories HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

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

get

Authorizations

Path parameters

idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7

Responses

200

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

404

An error occurred while entering the information

application/json

get

GET /contents/document-categories/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

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

get

Query parameters

categoryNamestringOptionalExample: settings

Responses

200

Successful Operation

application/json

ResponseanyExample:

{"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

GET /contents/public-documents HTTP/1.1
Host: 
Accept: */*

200

Successful Operation

{
  "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

Path parameters

idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7

Responses

200

Successful Operation

application/json

ResponseanyExample:

{"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}}

400

This error can occur because of an invalid value or because a value is required.

application/json

404

An error occurred while entering the information

application/json

get

GET /contents/public-documents/{id} HTTP/1.1
Host: 
Accept: */*

{
  "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
  }
}