Skip to content
API Reference
/
Clients

Onboarded API (0.0.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.onboarded.com/_mock/openapi/

https://app.onboarded.com/

Components

Components APIs

Operations

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

List all clients

Request

Security
bearerAuth
Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
custom_attributesstring

Stringified JSON to filter clients by custom attributes. Example: {"pay_rate": 12.5}

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/clients?page=1&per_page=20&custom_attributes=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​namestringrequired
data[].​created_atstring(date-time)required
data[].​updated_atstring(date-time)required
data[].​custom_attributesobjectrequired

Custom attribute values

totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create a client

Request

Security
bearerAuth
Bodyapplication/json

Body

namestringrequired
custom_attributesobject or null

Custom attributes

property name*anyadditional property
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/clients \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "custom_attributes": {}
  }'

Responses

201

Bodyapplication/json
idstringrequired
namestringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Get a client by id

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/clients/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Update a client

Request

Security
bearerAuth
Path
idstringrequired
Bodyapplication/json

Body

namestring
custom_attributesobject or null

Custom attributes

property name*anyadditional property
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/clients/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "custom_attributes": {}
  }'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Delete a client

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/clients/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Jobs

Jobs APIs

Operations

Placements

Placements APIs

Operations

Tasks

Tasks APIs

Operations

Task Change Requests

Task Change Requests APIs

Operations

Forms

Forms APIs

Operations

Files

Files APIs

Operations

Themes

Themes APIs

Operations

Custom Properties

Custom Properties APIs

Operations