Skip to content
API Reference
/
/
connected_organizations.d...

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

Operations

connected_organizations.list

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/connected_organizations?page=string&per_page=string&name=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(ConnectedOrganization)required
data[].​idstringrequired
data[].​namestringrequired
data[].​dba_namestring or nullrequired
Any of:
string
data[].​einstring or nullrequired
Any of:
string
data[].​business_emailstring or nullrequired
Any of:
string
data[].​candidate_support_emailstring or nullrequired
Any of:
string
data[].​phonestring or nullrequired
Any of:
string
data[].​live_account_idstringrequired
data[].​test_account_idstringrequired
data[].​default_languagestring or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
data[].​supported_languagesArray of strings or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
data[].​addressobject or nullrequired
Any of:
data[].​address.​streetstringrequired
data[].​address.​secondarystring or nullrequired
Any of:
string
data[].​address.​citystringrequired
data[].​address.​statestringrequired
data[].​address.​zipstring or nullrequired
Any of:
string
data[].​address.​countrystringrequired
Enum"AND""ARE""ATG""AIA""ALB""ARM""AGO""ATA""ARG""ASM"
data[].​address.​full_addressstringrequired
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

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

connected_organizations.create

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
namestringrequired
dba_namestring or null
Any of:
string
einstring or null
Any of:
string
business_emailstringrequired
candidate_support_emailstring or null
Any of:
string
phonestring or null
Any of:
string
default_languagestringrequired
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of stringsrequired
Items Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or null
Any of:
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/connected_organizations \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "dba_name": "string",
    "ein": "string",
    "business_email": "string",
    "candidate_support_email": "string",
    "phone": "string",
    "default_language": "af",
    "supported_languages": [
      "af"
    ],
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "AND",
      "full_address": "string"
    }
  }'

Responses

ConnectedOrganization

Bodyapplication/json
idstringrequired
namestringrequired
dba_namestring or nullrequired
Any of:
string
einstring or nullrequired
Any of:
string
business_emailstring or nullrequired
Any of:
string
candidate_support_emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
live_account_idstringrequired
test_account_idstringrequired
default_languagestring or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of strings or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or nullrequired
Any of:
address.​streetstringrequired
address.​secondarystring or nullrequired
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or nullrequired
Any of:
string
address.​countrystringrequired
Enum"AND""ARE""ATG""AIA""ALB""ARM""AGO""ATA""ARG""ASM"
address.​full_addressstringrequired
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

Response
application/json
{
  "id": "string",
  "name": "string",
  "dba_name": "string",
  "ein": "string",
  "business_email": "string",
  "candidate_support_email": "string",
  "phone": "string",
  "live_account_id": "string",
  "test_account_id": "string",
  "default_language": "af",
  "supported_languages": [
    "af"
  ],
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "AND",
    "full_address": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

connected_organizations.findById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
uidstring(ConnectedOrganizationId)required

Connected Organization Identifier

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

Responses

ConnectedOrganization

Bodyapplication/json
idstringrequired
namestringrequired
dba_namestring or nullrequired
Any of:
string
einstring or nullrequired
Any of:
string
business_emailstring or nullrequired
Any of:
string
candidate_support_emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
live_account_idstringrequired
test_account_idstringrequired
default_languagestring or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of strings or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or nullrequired
Any of:
address.​streetstringrequired
address.​secondarystring or nullrequired
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or nullrequired
Any of:
string
address.​countrystringrequired
Enum"AND""ARE""ATG""AIA""ALB""ARM""AGO""ATA""ARG""ASM"
address.​full_addressstringrequired
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

Response
application/json
{
  "id": "string",
  "name": "string",
  "dba_name": "string",
  "ein": "string",
  "business_email": "string",
  "candidate_support_email": "string",
  "phone": "string",
  "live_account_id": "string",
  "test_account_id": "string",
  "default_language": "af",
  "supported_languages": [
    "af"
  ],
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "AND",
    "full_address": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

connected_organizations.updateById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
uidstring(ConnectedOrganizationId)required

Connected Organization Identifier

Bodyapplication/jsonrequired
namestring
dba_namestring or null
Any of:
string
einstring or null
Any of:
string
business_emailstringrequired
candidate_support_emailstring or null
Any of:
string
phonestring or null
Any of:
string
default_languagestring
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of strings
Items Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or null
Any of:
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/connected_organizations/{uid}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "dba_name": "string",
    "ein": "string",
    "business_email": "string",
    "candidate_support_email": "string",
    "phone": "string",
    "default_language": "af",
    "supported_languages": [
      "af"
    ],
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "AND",
      "full_address": "string"
    }
  }'

Responses

ConnectedOrganization

Bodyapplication/json
idstringrequired
namestringrequired
dba_namestring or nullrequired
Any of:
string
einstring or nullrequired
Any of:
string
business_emailstring or nullrequired
Any of:
string
candidate_support_emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
live_account_idstringrequired
test_account_idstringrequired
default_languagestring or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of strings or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or nullrequired
Any of:
address.​streetstringrequired
address.​secondarystring or nullrequired
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or nullrequired
Any of:
string
address.​countrystringrequired
Enum"AND""ARE""ATG""AIA""ALB""ARM""AGO""ATA""ARG""ASM"
address.​full_addressstringrequired
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

Response
application/json
{
  "id": "string",
  "name": "string",
  "dba_name": "string",
  "ein": "string",
  "business_email": "string",
  "candidate_support_email": "string",
  "phone": "string",
  "live_account_id": "string",
  "test_account_id": "string",
  "default_language": "af",
  "supported_languages": [
    "af"
  ],
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "AND",
    "full_address": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

connected_organizations.deleteById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
uidstring(ConnectedOrganizationId)required

Connected Organization Identifier

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

Responses

ConnectedOrganization

Bodyapplication/json
idstringrequired
namestringrequired
dba_namestring or nullrequired
Any of:
string
einstring or nullrequired
Any of:
string
business_emailstring or nullrequired
Any of:
string
candidate_support_emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
live_account_idstringrequired
test_account_idstringrequired
default_languagestring or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
supported_languagesArray of strings or nullrequired
Any of:
string
Enum"af""ak""sq""am""ar""hy""as""ay""az""bm"
addressobject or nullrequired
Any of:
address.​streetstringrequired
address.​secondarystring or nullrequired
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or nullrequired
Any of:
string
address.​countrystringrequired
Enum"AND""ARE""ATG""AIA""ALB""ARM""AGO""ATA""ARG""ASM"
address.​full_addressstringrequired
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

Response
application/json
{
  "id": "string",
  "name": "string",
  "dba_name": "string",
  "ein": "string",
  "business_email": "string",
  "candidate_support_email": "string",
  "phone": "string",
  "live_account_id": "string",
  "test_account_id": "string",
  "default_language": "af",
  "supported_languages": [
    "af"
  ],
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "AND",
    "full_address": "string"
  },
  "created_at": "string",
  "updated_at": "string"
}

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

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