Skip to content
/Components

Components

API for creating embeddable component URLs

Operations

Create a component URL

Request

Security
form_session or user_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
Any of:
Any of:
componentstringrequired
Value:"employees/list"
filtersobject
optionsobject
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/components/create_url \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "component": "employees/list",
    "filters": {
      "after": "string",
      "before": "string",
      "limit": "string",
      "order_by": "string",
      "order_dir": "string",
      "employee_id": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "email": "string",
      "status": "string",
      "custom_attributes": "string",
      "system_attributes": "string",
      "custom_view_id": "string",
      "created_at_from": "string",
      "created_at_to": "string",
      "latest_task_updated_at_from": "string",
      "latest_task_updated_at_to": "string",
      "next_task_due_at_from": "string",
      "next_task_due_at_to": "string",
      "progress_min": "string",
      "progress_max": "string",
      "placements_count_min": "string",
      "placements_count_max": "string"
    },
    "options": {
      "redirect_url_expires_in": 0,
      "session_expires_in": 0
    }
  }'

Responses

Success

Bodyapplication/json
componentstringrequired
Enum:"employees/list""everify/cases""employee/tasks"
redirect_urlstringrequired
codestringrequired
Response
{
  "component": "employees/list",
  "redirect_url": "string",
  "code": "string"
}