Get a placement by ID

Request

Security

form_session or user_session or component_session or component_token or api_token

Path

placement_idstring(PlacementId)^pla_required

Placement Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{placement_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Bodyapplication/json

idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired

Any of:

Employer Identifier

string(EmployerId)

client_idClientId (string) or nullrequired

Any of:

Client Identifier

string(ClientId)

job_idJobId (string) or nullrequired

Any of:

Job Identifier

string(JobId)

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

missing_task_countnumberrequired

progressobjectrequired

form_requirementsArray of objectsrequired

suggested_tasksArray of objectsrequired

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

{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}