Admin - API Endpoints

To use the following endpoints, you must have the role of administrator or super administrator.

GET/admin/contents/onboardings

Authorization

bearer

Response

200401403404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

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

Response

200401403404

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

POST/admin/contents/onboardings

Authorization

bearer

Body

application/json

name*string

Example: "Welcome App"

enabled*boolean

Example: false

type*enum

Example: "APP_ONBOARDING"

APP_ONBOARDINGMARKETING_ONBOARDING

Response

201400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboardings', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Welcome App",
      "enabled": false,
      "type": "APP_ONBOARDING"
    }),
});
const data = await response.json();

Response

201400401403404

{
  "statusCode": 201
}

GET/admin/contents/onboardings/types

Authorization

bearer

Response

200401403404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

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

Response

200401403404

{
  "statusCode": 200,
  "data": {
    "types": [
      "APP_ONBOARDING"
    ]
  }
}

GET/admin/contents/onboardings/{slug}

Authorization

bearer

Path parameters

slug*string

Query parameters

Response

200401403404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboardings/{slug}?includeSlides=false', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404

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

DELETE/admin/contents/onboardings/{slug}

Authorization

bearer

Path parameters

slug*string

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

200400401403404

{
  "statusCode": 200
}

PATCH/admin/contents/onboardings/{slug}

Authorization

bearer

Path parameters

slug*string

Body

application/json

namestring

Example: "Welcome App"

enabledboolean

Example: false

typeenum

Example: "APP_ONBOARDING"

APP_ONBOARDINGMARKETING_ONBOARDING

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboardings/{slug}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "statusCode": 200
}

GET/admin/contents/onboardings/{slug}/slides

Authorization

bearer

Path parameters

slug*string

Response

200400401403404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

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

Response

200400401403404

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

POST/admin/contents/onboarding-slides

Authorization

bearer

Body

application/json

title*string

Example: "Check Deposits"

content*string

Example: "Lorem Ipsum is simply dummy text of the printing and typesetting industry."

image*string

Example: "https://dummyimage.com/300x300/000/fff"

onboardingId*string

Example: "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"

Response

201400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboarding-slides', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "Check Deposits",
      "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
      "image": "https://dummyimage.com/300x300/000/fff",
      "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
    }),
});
const data = await response.json();

Response

201400401403404

{
  "statusCode": 201
}

DELETE/admin/contents/onboarding-slides/{id}

Authorization

bearer

Path parameters

id*string

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboarding-slides/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403404

{
  "statusCode": 200
}

PATCH/admin/contents/onboarding-slides/{id}

Authorization

bearer

Path parameters

id*string

Body

application/json

titlestring

Example: "Check Deposits"

contentstring

Example: "Lorem Ipsum is simply dummy text of the printing and typesetting industry."

imagestring

Example: "https://dummyimage.com/300x300/000/fff"

indexnumber

Through this field you can order the onboarding screens.

Example: 0

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboarding-slides/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "statusCode": 200
}

GET/admin/contents/onboardings/types/{type}

Authorization

bearer

Path parameters

type*string

Query parameters

Response

200401403404

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/onboardings/types/{type}?includeSlides=false', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403404

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