Client - API Endpoints

get
Authorizations
Responses
200
Successful Operation
application/json
get
GET /contents/onboardings HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200,
  "data": {
    "onboardings": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
        "name": "Onboarding App",
        "slug": "onboarding-app",
        "type": "APP_ONBOARDING",
        "enabled": true
      }
    ]
  }
}
get
Authorizations
Path parameters
slugstringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200
Successful Operation
application/json
get
GET /contents/onboardings/{slug}?includeSlides=true HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "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"
      }
    ]
  }
}
get
Authorizations
Path parameters
slugstringRequired
Responses
200
Successful Operation
application/json
get
GET /contents/onboardings/{slug}/slides HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "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"
      }
    ]
  }
}
get
Authorizations
Path parameters
typestringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200
Successful Operation
application/json
get
GET /contents/onboardings/types/{type}?includeSlides=true HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "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"
      }
    ]
  }
}

Last updated

Was this helpful?