Client - API Endpoints

PreviousAdmin - API Endpoints NextDocuments

Last updated 1 year ago

Was this helpful?

get

/contents/onboardings

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "statusCode": 200,
  "data": {
    "onboardings": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
        "name": "Onboarding App",
        "slug": "onboarding-app",
        "type": "APP_ONBOARDING",
        "enabled": true
      }
    ]
  }
}

Successful Operation

get

/contents/onboardings/{slug}

Authorizations

Path parameters

slugstringrequired

Query parameters

includeSlidesbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/onboardings/{slug}?includeSlides=true' \
  --header 'Authorization: Bearer JWT'

200

401

404

{
  "statusCode": 200,
  "data": {
    "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
    "name": "Onboarding App",
    "slug": "onboarding-app",
    "type": "APP_ONBOARDING",
    "enabled": true,
    "onboardingSlides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation

get

/contents/onboardings/{slug}/slides

Authorizations

Path parameters

slugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/onboardings/{slug}/slides' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

{
  "statusCode": 200,
  "data": {
    "slides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation

get

/contents/onboardings/types/{type}

Authorizations

Path parameters

typestringrequired

Query parameters

includeSlidesbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contents/onboardings/types/{type}?includeSlides=true' \
  --header 'Authorization: Bearer JWT'

200

401

404

{
  "statusCode": 200,
  "data": {
    "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
    "name": "Onboarding App",
    "slug": "onboarding-app",
    "type": "APP_ONBOARDING",
    "enabled": true,
    "onboardingSlides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation