Admin - API Endpoints

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

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

get

/admin/contents/onboardings

HTTPcURLJavaScriptPython

GET /admin/contents/onboardings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequiredExample: Welcome App

enabledbooleanRequiredExample: false

typestring · enumRequiredExample: APP_ONBOARDINGPossible values:

Responses

201

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

post

/admin/contents/onboardings

HTTPcURLJavaScriptPython

POST /admin/contents/onboardings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "Welcome App",
  "enabled": false,
  "type": "APP_ONBOARDING"
}

{
  "statusCode": 201
}

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

get

/admin/contents/onboardings/types

HTTPcURLJavaScriptPython

GET /admin/contents/onboardings/types HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

slugstringRequired

Query parameters

includeSlidesbooleanRequired

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

get

/admin/contents/onboardings/{slug}

HTTPcURLJavaScriptPython

GET /admin/contents/onboardings/{slug}?includeSlides=true HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

slugstringRequired

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

delete

/admin/contents/onboardings/{slug}

HTTPcURLJavaScriptPython

DELETE /admin/contents/onboardings/{slug} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}

patch

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

slugstringRequired

Body

application/json

namestringOptionalExample: Welcome App

enabledbooleanOptionalExample: false

typestring · enumOptionalExample: APP_ONBOARDINGPossible values:

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

patch

/admin/contents/onboardings/{slug}

HTTPcURLJavaScriptPython

PATCH /admin/contents/onboardings/{slug} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "Welcome App",
  "enabled": false,
  "type": "APP_ONBOARDING"
}

{
  "statusCode": 200
}

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

slugstringRequired

Responses

200

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

get

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

HTTPcURLJavaScriptPython

GET /admin/contents/onboardings/{slug}/slides HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

post

/admin/contents/onboarding-slides

HTTPcURLJavaScriptPython

POST /admin/contents/onboarding-slides HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /admin/contents/onboarding-slides/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}

patch

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

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}

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /admin/contents/onboarding-slides/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestringRequired

Query parameters

includeSlidesbooleanRequired

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

An error occurred while entering the information

application/json

get

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

HTTPcURLJavaScriptPython

GET /admin/contents/onboardings/types/{type}?includeSlides=true HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
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"
      }
    ]
  }
}