Skip to content
API Reference
/
/
jobs.findById

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

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

jobs.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

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

Responses

Success

Bodyapplication/json
dataArray of objects(Job)required
data[].​idstring(JobId)^job_required

Job Identifier

data[].​namestringrequired
data[].​addressAddress (object) or nullrequired
Any of:

An address resource

data[].​address.​streetstringrequired
data[].​address.​secondarystring or null
Any of:
string
data[].​address.​citystringrequired
data[].​address.​statestringrequired
data[].​address.​zipstring or null
Any of:
string
data[].​address.​countrystringrequired
data[].​address.​full_addressstring or null
Any of:
string
data[].​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

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[].​property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

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

jobs.create

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
namestringrequired
addressAddress (object) or null
Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/jobs \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.

Bodyapplication/json
idstring(JobId)^job_required

Job Identifier

namestringrequired
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

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

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "job_abc123def456",
  "name": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

jobs.findById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
job_idstring(JobId)^job_required

Job Identifier

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

Responses

A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.

Bodyapplication/json
idstring(JobId)^job_required

Job Identifier

namestringrequired
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

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

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "job_abc123def456",
  "name": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

jobs.updateById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
job_idstring(JobId)^job_required

Job Identifier

Bodyapplication/jsonrequired
namestring
addressAddress (object) or null
Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/jobs/{job_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.

Bodyapplication/json
idstring(JobId)^job_required

Job Identifier

namestringrequired
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

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

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "job_abc123def456",
  "name": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

jobs.deleteById

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
job_idstring(JobId)^job_required

Job Identifier

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

Responses

A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.

Bodyapplication/json
idstring(JobId)^job_required

Job Identifier

namestringrequired
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

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

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "job_abc123def456",
  "name": "string",
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

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