Clients

API for managing clients

Operations

List all clients

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

Responses

Success

Bodyapplication/json

dataArray of objects(Client)required

data[].idstring(ClientId)^cl_required

Client Identifier

data[].namestringrequired

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
}

Create a new client

Request

Security

user_session or form_session or component_session or component_token or api_token

Bodyapplication/jsonrequired

namestringrequired

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/clients \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A client 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 client schema.

Bodyapplication/json

idstring(ClientId)^cl_required

Client Identifier

namestringrequired

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": "cl_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Get a client by ID

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

client_idstring(ClientId)^cl_required

Client Identifier

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

Responses

A client 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 client schema.

Bodyapplication/json

idstring(ClientId)^cl_required

Client Identifier

namestringrequired

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": "cl_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Update a client

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

client_idstring(ClientId)^cl_required

Client Identifier

Bodyapplication/jsonrequired

namestring

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/clients/{client_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A client 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 client schema.

Bodyapplication/json

idstring(ClientId)^cl_required

Client Identifier

namestringrequired

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": "cl_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Delete a client

Request

Security

user_session or form_session or component_session or component_token or api_token

Path

client_idstring(ClientId)^cl_required

Client Identifier

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

Responses

A client 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 client schema.

Bodyapplication/json

idstring(ClientId)^cl_required

Client Identifier

namestringrequired

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": "cl_abc123def456",
  "name": "string",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

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

Custom Properties

API for managing custom properties

Operations

Magic Links

API for creating magic links for user authentication

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

Onboarded Public API (0.0.1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Clients

List all clients

Request

Responses

Was this helpful?

Create a new client

Request

Responses

Was this helpful?

Get a client by ID

Request

Responses

Was this helpful?

Update a client

Request

Responses

Was this helpful?

Delete a client

Request

Responses

Was this helpful?

Components

Connected Organizations

Employees

Employers

Files

Forms

Tasks

Jobs

Placements

Themes

Custom Properties

Magic Links

Subtasks

Task Change Requests

Users

Webhooks

Onboarded Public API (0.0.1)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Clients

List all clients

Request

Responses

Was this helpful?

Create a new client

Request

Responses

Was this helpful?

Get a client by ID

Request

Responses

Was this helpful?

Update a client

Request

Responses

Was this helpful?

Delete a client

Request

Responses

Was this helpful?

Components

Connected Organizations

Employees

Employers

Files

Forms

Tasks

Jobs

Placements

Themes

Custom Properties

Magic Links

Subtasks

Task Change Requests

Users

Webhooks

Onboarded Public API (0.0.1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude