Skip to content
/Themes

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

List all themes

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

namestring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/themes?page=string&per_page=string&name=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Theme)required
data[].​idstring(ThemeId)^theme_required

Theme Identifier

data[].​namestring(nonEmptyString)non-emptyrequired

a non empty string

data[].​lightobject
data[].​darkobject
data[].​created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​_tagstringrequired
Value"Theme"
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a new theme

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
namestring(nonEmptyString)non-emptyrequired

a non empty string

lightobject
darkobject
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/themes \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "light": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    },
    "dark": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    }
  }'

Responses

Theme

Bodyapplication/json
idstring(ThemeId)^theme_required

Theme Identifier

namestring(nonEmptyString)non-emptyrequired

a non empty string

lightobject
darkobject
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value"Theme"
Response
application/json
{
  "id": "theme_abc123def456",
  "name": "string",
  "light": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "dark": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Theme"
}

Get a theme by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
theme_idstring(ThemeId)^theme_required

Theme Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/themes/{theme_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

Theme

Bodyapplication/json
idstring(ThemeId)^theme_required

Theme Identifier

namestring(nonEmptyString)non-emptyrequired

a non empty string

lightobject
darkobject
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value"Theme"
Response
application/json
{
  "id": "theme_abc123def456",
  "name": "string",
  "light": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "dark": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Theme"
}

Update a theme

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
theme_idstring(ThemeId)^theme_required

Theme Identifier

Bodyapplication/jsonrequired
namestring(nonEmptyString)non-empty

a non empty string

lightobject
darkobject
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/themes/{theme_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "light": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    },
    "dark": {
      "logo": "string",
      "show_header": true,
      "show_form_name": true,
      "show_updated_fields_count": true,
      "next_button_text": "string",
      "back_button_text": "string",
      "custom_background": "#FFF",
      "custom_foreground": "#FFF",
      "primary_background": "#FFF",
      "primary_foreground": "#FFF",
      "secondary_background": "#FFF",
      "secondary_foreground": "#FFF",
      "progress": "#FFF",
      "border": "#FFF",
      "radius": "string"
    }
  }'

Responses

Theme

Bodyapplication/json
idstring(ThemeId)^theme_required

Theme Identifier

namestring(nonEmptyString)non-emptyrequired

a non empty string

lightobject
darkobject
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value"Theme"
Response
application/json
{
  "id": "theme_abc123def456",
  "name": "string",
  "light": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "dark": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Theme"
}

Delete a theme

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
theme_idstring(ThemeId)^theme_required

Theme Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/themes/{theme_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

Theme

Bodyapplication/json
idstring(ThemeId)^theme_required

Theme Identifier

namestring(nonEmptyString)non-emptyrequired

a non empty string

lightobject
darkobject
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value"Theme"
Response
application/json
{
  "id": "theme_abc123def456",
  "name": "string",
  "light": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "dark": {
    "logo": "string",
    "show_header": true,
    "show_form_name": true,
    "show_updated_fields_count": true,
    "next_button_text": "string",
    "back_button_text": "string",
    "custom_background": "#FFF",
    "custom_foreground": "#FFF",
    "primary_background": "#FFF",
    "primary_foreground": "#FFF",
    "secondary_background": "#FFF",
    "secondary_foreground": "#FFF",
    "progress": "#FFF",
    "border": "#FFF",
    "radius": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Theme"
}

Custom Properties

API for managing custom properties

Operations

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations