Admin - API Endpoints

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

get
Authorizations
Responses
200
Successful Operation
application/json
get
GET /admin/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
      }
    ]
  }
}
post
Authorizations
Body
namestringRequiredExample: Welcome App
enabledbooleanRequiredExample: false
typestring · enumRequiredExample: APP_ONBOARDINGPossible values:
Responses
201
Successful Operation
application/json
ResponseanyExample: {"statusCode":201}
post
POST /admin/contents/onboardings HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "Welcome App",
  "enabled": false,
  "type": "APP_ONBOARDING"
}
{
  "statusCode": 201
}
get
Authorizations
Responses
200
Successful Operation
application/json
get
GET /admin/contents/onboardings/types HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200,
  "data": {
    "types": [
      "APP_ONBOARDING"
    ]
  }
}
get
Authorizations
Path parameters
slugstringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200
Successful Operation
application/json
get
GET /admin/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"
      }
    ]
  }
}
delete
Authorizations
Path parameters
slugstringRequired
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
delete
DELETE /admin/contents/onboardings/{slug} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200
}
patch
Authorizations
Path parameters
slugstringRequired
Body
namestringOptionalExample: Welcome App
enabledbooleanOptionalExample: false
typestring · enumOptionalExample: APP_ONBOARDINGPossible values:
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
patch
PATCH /admin/contents/onboardings/{slug} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "Welcome App",
  "enabled": false,
  "type": "APP_ONBOARDING"
}
{
  "statusCode": 200
}
get
Authorizations
Path parameters
slugstringRequired
Responses
200
Successful Operation
application/json
get
GET /admin/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"
      }
    ]
  }
}
post
Authorizations
Body
titlestringRequiredExample: Check Deposits
contentstringRequiredExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
imagestringRequiredExample: https://dummyimage.com/300x300/000/fff
onboardingIdstringRequiredExample: c3d1d81d-2eb7-4c01-8a8d-904fd951a17d
Responses
201
Successful Operation
application/json
ResponseanyExample: {"statusCode":201}
post
POST /admin/contents/onboarding-slides HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "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"
}
{
  "statusCode": 201
}
delete
Authorizations
Path parameters
idstringRequired
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
delete
DELETE /admin/contents/onboarding-slides/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200
}
patch
Authorizations
Path parameters
idstringRequired
Body
titlestringOptionalExample: Check Deposits
contentstringOptionalExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
imagestringOptionalExample: https://dummyimage.com/300x300/000/fff
indexnumberOptional

Through this field you can order the onboarding screens.

Example: 0
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
patch
PATCH /admin/contents/onboarding-slides/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "title": "Check Deposits",
  "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
  "image": "https://dummyimage.com/300x300/000/fff",
  "index": 0
}
{
  "statusCode": 200
}
get
Authorizations
Path parameters
typestringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200
Successful Operation
application/json
get
GET /admin/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?