Client - API Endpoints

PreviousDocument NextAdmin - API Endpoints

Last updated 2 years ago

Was this helpful?

get

/contents/documents

Authorizations

Query parameters

categoryNamestring

Example: settings

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/documents' \
  --header 'Authorization: Bearer JWT'

200

401

{
  "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",
        "isPublic": false,
        "expiresAt": "2022-12-07T17:21:27.548Z",
        "format": "url"
      }
    ]
  }
}

Successful Operation

get

/contents/documents/{id}

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/documents/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

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

Successful Operation

get

/contents/document-categories

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/document-categories' \
  --header 'Authorization: Bearer JWT'

200

401

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

Successful Operation

get

/contents/document-categories/{id}

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/document-categories/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

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

Successful Operation

get

/contents/public-documents

Query parameters

categoryNamestring

Example: settings

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/public-documents'

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
      }
    ]
  }
}

Successful Operation

get

/contents/public-documents/{id}

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/public-documents/{id}'

200

400

404

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

Successful Operation