{ "openapi": "3.1.0", "info": { "title": "Onboarded Public API", "version": "0.0.1", "description": "Public API for Customers, Partners, and Integrations" }, "paths": { "/api/v1/clients": { "get": { "tags": [ "Clients" ], "operationId": "clients.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "custom_attributes", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all clients" }, "post": { "tags": [ "Clients" ], "operationId": "clients.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/ClientId" }, "name": { "type": "string" }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Client" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a new client", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } } }, "/api/v1/clients/{client_id}": { "get": { "tags": [ "Clients" ], "operationId": "clients.findById", "parameters": [ { "name": "client_id", "in": "path", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a client by ID" }, "patch": { "tags": [ "Clients" ], "operationId": "clients.updateById", "parameters": [ { "name": "client_id", "in": "path", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a client", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string" }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "delete": { "tags": [ "Clients" ], "operationId": "clients.deleteById", "parameters": [ { "name": "client_id", "in": "path", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a client" } }, "/api/v1/components/create_url": { "post": { "tags": [ "Components" ], "operationId": "components.createUrl", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "component", "redirect_url", "code" ], "properties": { "component": { "type": "string", "enum": [ "employees/list", "everify/cases", "employee/tasks" ] }, "redirect_url": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a component URL", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "component" ], "properties": { "component": { "type": "string", "enum": [ "employees/list" ] }, "filters": { "type": "object", "required": [], "properties": { "page": { "type": "string" }, "per_page": { "type": "string" }, "order_by": { "type": "string" }, "order_dir": { "type": "string" }, "employee_id": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string" }, "custom_attributes": { "type": "string" }, "system_attributes": { "type": "string" }, "custom_view_id": { "type": "string" }, "created_at_from": { "type": "string" }, "created_at_to": { "type": "string" }, "latest_task_updated_at_from": { "type": "string" }, "latest_task_updated_at_to": { "type": "string" }, "next_task_due_at_from": { "type": "string" }, "next_task_due_at_to": { "type": "string" }, "progress_min": { "type": "string" }, "progress_max": { "type": "string" }, "placements_count_min": { "type": "string" }, "placements_count_max": { "type": "string" } }, "additionalProperties": false }, "options": { "type": "object", "required": [], "properties": { "redirect_url_expires_in": { "type": "number" }, "session_expires_in": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "component" ], "properties": { "component": { "type": "string", "enum": [ "everify/cases" ] }, "filters": { "type": "object", "required": [], "properties": { "page": { "type": "string" }, "per_page": { "type": "string" }, "case_statuses": { "type": "string" }, "case_tracking": { "type": "string" } }, "additionalProperties": false }, "options": { "type": "object", "required": [], "properties": { "redirect_url_expires_in": { "type": "number" }, "session_expires_in": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } ] }, { "type": "object", "required": [ "component", "employee_id" ], "properties": { "component": { "type": "string", "enum": [ "employee/tasks" ] }, "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "filters": { "type": "object", "required": [], "properties": { "task_id": { "type": "string" }, "employee_id": { "type": "string" }, "employer_id": { "type": "string" }, "client_id": { "type": "string" }, "job_id": { "type": "string" }, "form_id": { "type": "string" }, "employee_cv_uid": { "type": "string" }, "progress": { "type": "string" }, "next_action": { "type": "string" }, "custom_view_id": { "type": "string" }, "assignee": { "type": "string" }, "order_by": { "type": "string" }, "order_dir": { "type": "string" }, "page": { "type": "string" }, "per_page": { "type": "string" } }, "additionalProperties": false }, "options": { "type": "object", "required": [], "properties": { "redirect_url_expires_in": { "type": "number" }, "session_expires_in": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } ] } } }, "required": true } } }, "/api/v1/connected_organizations": { "get": { "tags": [ "Connected Organizations" ], "operationId": "connected_organizations.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedOrganization" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all connected organizations" }, "post": { "tags": [ "Connected Organizations" ], "operationId": "connected_organizations.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "ConnectedOrganization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedOrganization" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a connected organization", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "business_email", "default_language", "supported_languages" ], "properties": { "name": { "type": "string" }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "business_email": { "type": "string" }, "candidate_support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_language": { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] }, "supported_languages": { "type": "array", "items": { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] } }, "address": { "anyOf": [ { "type": "object", "required": [ "street", "city", "state", "country", "full_address" ], "properties": { "street": { "type": "string" }, "secondary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "type": "string", "enum": [ "AND", "ARE", "ATG", "AIA", "ALB", "ARM", "AGO", "ATA", "ARG", "ASM", "AUT", "AUS", "ABW", "ALA", "AZE", "BIH", "BRB", "BGD", "BEL", "BFA", "BGR", "BHR", "BDI", "BEN", "BLM", "BMU", "BRN", "BOL", "BES", "BRA", "BHS", "BTN", "BVT", "BWA", "BLR", "BLZ", "CAN", "CCK", "COD", "CAF", "COG", "CHE", "CIV", "COK", "CHL", "CHN", "CMR", "COL", "CRI", "CPV", "CUW", "CXR", "CYP", "CZE", "DEU", "DJI", "DNK", "DMA", "DOM", "DZA", "ECU", "EST", "EGY", "ESH", "ERI", "ESP", "ETH", "FIN", "FJI", "FLK", "FSM", "FRO", "FRA", "GAB", "GBR", "GRD", "GEO", "GUF", "GGY", "GHA", "GIB", "GRL", "GMB", "GIN", "GLP", "GNQ", "GRC", "SGS", "GTM", "GUM", "GNB", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IRL", "ISR", "IMN", "IND", "IOT", "IRQ", "ISL", "ITA", "JEY", "JAM", "JOR", "JPN", "KEN", "KGZ", "KHM", "KIR", "COM", "KNA", "KOR", "KWT", "CYM", "KAZ", "LAO", "LBN", "LCA", "LIE", "LKA", "LBR", "LSO", "LTU", "LUX", "LVA", "LBY", "MAR", "MCO", "MDA", "MNE", "MAF", "MDG", "MHL", "MKD", "MLI", "MMR", "MNG", "MAC", "MNP", "MTQ", "MRT", "MSR", "MLT", "MUS", "MDV", "MWI", "MEX", "MYS", "MOZ", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NLD", "NOR", "NPL", "NRU", "NIU", "NZL", "OMN", "PAN", "PER", "PYF", "PNG", "PHL", "PAK", "POL", "SPM", "PCN", "PRI", "PSE", "PRT", "PLW", "PRY", "QAT", "REU", "ROU", "SRB", "RUS", "RWA", "SAU", "SLB", "SYC", "SWE", "SGP", "SHN", "SVN", "SJM", "SVK", "SLE", "SMR", "SEN", "SOM", "SUR", "SSD", "STP", "SLV", "SXM", "SWZ", "TCA", "TCD", "ATF", "TGO", "THA", "TJK", "TKL", "TLS", "TKM", "TUN", "TON", "TUR", "TTO", "TUV", "TWN", "TZA", "UKR", "UGA", "UMI", "USA", "URY", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "MYT", "ZAF", "ZMB", "ZWE" ] }, "full_address": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/connected_organizations/{uid}": { "get": { "tags": [ "Connected Organizations" ], "operationId": "connected_organizations.findById", "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string", "description": "Connected Organization Identifier", "title": "ConnectedOrganizationId" }, "required": true, "description": "Connected Organization Identifier" } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "ConnectedOrganization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedOrganization" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a connected organization by ID" }, "patch": { "tags": [ "Connected Organizations" ], "operationId": "connected_organizations.updateById", "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string", "description": "Connected Organization Identifier", "title": "ConnectedOrganizationId" }, "required": true, "description": "Connected Organization Identifier" } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "ConnectedOrganization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedOrganization" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a connected organization", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string" }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "business_email": { "type": "string" }, "candidate_support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "default_language": { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] }, "supported_languages": { "type": "array", "items": { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] } }, "address": { "anyOf": [ { "type": "object", "required": [ "street", "city", "state", "country", "full_address" ], "properties": { "street": { "type": "string" }, "secondary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "type": "string", "enum": [ "AND", "ARE", "ATG", "AIA", "ALB", "ARM", "AGO", "ATA", "ARG", "ASM", "AUT", "AUS", "ABW", "ALA", "AZE", "BIH", "BRB", "BGD", "BEL", "BFA", "BGR", "BHR", "BDI", "BEN", "BLM", "BMU", "BRN", "BOL", "BES", "BRA", "BHS", "BTN", "BVT", "BWA", "BLR", "BLZ", "CAN", "CCK", "COD", "CAF", "COG", "CHE", "CIV", "COK", "CHL", "CHN", "CMR", "COL", "CRI", "CPV", "CUW", "CXR", "CYP", "CZE", "DEU", "DJI", "DNK", "DMA", "DOM", "DZA", "ECU", "EST", "EGY", "ESH", "ERI", "ESP", "ETH", "FIN", "FJI", "FLK", "FSM", "FRO", "FRA", "GAB", "GBR", "GRD", "GEO", "GUF", "GGY", "GHA", "GIB", "GRL", "GMB", "GIN", "GLP", "GNQ", "GRC", "SGS", "GTM", "GUM", "GNB", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IRL", "ISR", "IMN", "IND", "IOT", "IRQ", "ISL", "ITA", "JEY", "JAM", "JOR", "JPN", "KEN", "KGZ", "KHM", "KIR", "COM", "KNA", "KOR", "KWT", "CYM", "KAZ", "LAO", "LBN", "LCA", "LIE", "LKA", "LBR", "LSO", "LTU", "LUX", "LVA", "LBY", "MAR", "MCO", "MDA", "MNE", "MAF", "MDG", "MHL", "MKD", "MLI", "MMR", "MNG", "MAC", "MNP", "MTQ", "MRT", "MSR", "MLT", "MUS", "MDV", "MWI", "MEX", "MYS", "MOZ", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NLD", "NOR", "NPL", "NRU", "NIU", "NZL", "OMN", "PAN", "PER", "PYF", "PNG", "PHL", "PAK", "POL", "SPM", "PCN", "PRI", "PSE", "PRT", "PLW", "PRY", "QAT", "REU", "ROU", "SRB", "RUS", "RWA", "SAU", "SLB", "SYC", "SWE", "SGP", "SHN", "SVN", "SJM", "SVK", "SLE", "SMR", "SEN", "SOM", "SUR", "SSD", "STP", "SLV", "SXM", "SWZ", "TCA", "TCD", "ATF", "TGO", "THA", "TJK", "TKL", "TLS", "TKM", "TUN", "TON", "TUR", "TTO", "TUV", "TWN", "TZA", "UKR", "UGA", "UMI", "USA", "URY", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "MYT", "ZAF", "ZMB", "ZWE" ] }, "full_address": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Connected Organizations" ], "operationId": "connected_organizations.deleteById", "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string", "description": "Connected Organization Identifier", "title": "ConnectedOrganizationId" }, "required": true, "description": "Connected Organization Identifier" } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "ConnectedOrganization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedOrganization" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a connected organization" } }, "/api/v1/employees": { "get": { "tags": [ "Employees" ], "operationId": "employees.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "custom_attributes", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all employees" }, "post": { "tags": [ "Employees" ], "operationId": "employees.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "An employee 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 employee schema.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "first_name", "last_name", "email", "phone", "date_of_birth", "social_security_number", "has_middle_name", "address", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/EmployeeId" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "social_security_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_middle_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "An employee 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 employee schema.", "title": "Employee" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a new employee", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "first_name", "last_name" ], "properties": { "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "social_security_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_middle_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } } }, "/api/v1/employees/{employee_id}": { "get": { "tags": [ "Employees" ], "operationId": "employees.findById", "parameters": [ { "name": "employee_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employee 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 employee schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get an employee by ID" }, "patch": { "tags": [ "Employees" ], "operationId": "employees.updateById", "parameters": [ { "name": "employee_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employee 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 employee schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update an employee", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "social_security_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_middle_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "delete": { "tags": [ "Employees" ], "operationId": "employees.deleteById", "parameters": [ { "name": "employee_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employee 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 employee schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete an employee" } }, "/api/v1/employees/{employee_id}/onboarding": { "get": { "tags": [ "Employees" ], "operationId": "employees.getOnboardingUrl", "parameters": [ { "name": "employee_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true }, { "name": "assignee_type", "in": "query", "schema": { "type": "string", "enum": [ "employee", "employer" ], "description": "Type of assignee for onboarding tasks. Defaults to \"employee\"." }, "required": false, "description": "Type of assignee for onboarding tasks. Defaults to \"employee\"." }, { "name": "task_ids", "in": "query", "schema": { "type": "string", "description": "Comma-separated list of task IDs" }, "required": false, "description": "Comma-separated list of task IDs" }, { "name": "locale", "in": "query", "schema": { "type": "string", "description": "Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability." }, "required": false, "description": "Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability." }, { "name": "redirect_to", "in": "query", "schema": { "type": "string", "description": "Redirect to URL to send the user after onboarding is complete" }, "required": false, "description": "Redirect to URL to send the user after onboarding is complete" }, { "name": "active_theme_id", "in": "query", "schema": { "type": "string", "description": "Custom theme for the onboarding form" }, "required": false, "description": "Custom theme for the onboarding form" } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get onboarding URL for an employee" } }, "/api/v1/employees/{employee_id}/migrate_completed_tasks_progress": { "patch": { "tags": [ "Employees" ], "operationId": "employees.migrateTaskProgress", "parameters": [ { "name": "employee_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "204": { "description": "Success" }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Migrate completed task progress", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "target_employee_id" ], "properties": { "target_employee_id": { "$ref": "#/components/schemas/EmployeeId" } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/employers": { "get": { "tags": [ "Employers" ], "operationId": "employers.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "custom_attributes", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employer" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all employers" }, "post": { "tags": [ "Employers" ], "operationId": "employers.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "An employer 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 employer schema.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "ein", "dba_name", "phone", "employee_count", "entity_structure", "naics_code", "address", "custom_attributes", "active_theme_id", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/EmployerId" }, "name": { "type": "string" }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "entity_structure": { "anyOf": [ { "type": "string", "enum": [ "sole_proprietorship", "partnership", "llc", "corporation", "nonprofit", "cooperative", "professional_corporation" ], "description": "Legal entity structure of the employer", "title": "EntityStructure" }, { "type": "null" } ] }, "naics_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "active_theme_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "An employer 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 employer schema.", "title": "Employer" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Create a new employer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "entity_structure": { "anyOf": [ { "type": "string", "enum": [ "sole_proprietorship", "partnership", "llc", "corporation", "nonprofit", "cooperative", "professional_corporation" ], "description": "Legal entity structure of the employer", "title": "EntityStructure" }, { "type": "null" } ] }, "naics_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "active_theme_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } } }, "/api/v1/employers/{employer_id}": { "get": { "tags": [ "Employers" ], "operationId": "employers.findById", "parameters": [ { "name": "employer_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employer 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 employer schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employer" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get an employer by ID" }, "patch": { "tags": [ "Employers" ], "operationId": "employers.updateById", "parameters": [ { "name": "employer_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employer 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 employer schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employer" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update an employer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string" }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "entity_structure": { "anyOf": [ { "type": "string", "enum": [ "sole_proprietorship", "partnership", "llc", "corporation", "nonprofit", "cooperative", "professional_corporation" ], "description": "Legal entity structure of the employer", "title": "EntityStructure" }, { "type": "null" } ] }, "naics_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "active_theme_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "delete": { "tags": [ "Employers" ], "operationId": "employers.deleteById", "parameters": [ { "name": "employer_id", "in": "path", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "An employer 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 employer schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employer" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete an employer" } }, "/api/v1/files/{file_id}": { "get": { "tags": [ "Files" ], "operationId": "files.findById", "parameters": [ { "name": "file_id", "in": "path", "schema": { "$ref": "#/components/schemas/FileId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "FileResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponse" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a file by ID" } }, "/api/v1/forms": { "get": { "tags": [ "Forms" ], "operationId": "forms.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Form" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all forms" } }, "/api/v1/forms/{form_id}": { "get": { "tags": [ "Forms" ], "operationId": "forms.findById", "parameters": [ { "name": "form_id", "in": "path", "schema": { "$ref": "#/components/schemas/FormId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Form", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a form by ID" } }, "/api/v1/tasks": { "get": { "tags": [ "Tasks" ], "operationId": "tasks.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "form_id", "in": "query", "schema": { "$ref": "#/components/schemas/FormId" }, "required": false }, { "name": "employee_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": false }, { "name": "employer_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": false }, { "name": "client_id", "in": "query", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": false }, { "name": "job_id", "in": "query", "schema": { "$ref": "#/components/schemas/JobId" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "requires_action", "completed", "expired" ] }, "required": false }, { "name": "expired_at_lte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "expired_at_gte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "due_at_lte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "due_at_gte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "completed_at_lte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "completed_at_gte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "created_at_lte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false }, { "name": "created_at_gte", "in": "query", "schema": { "$ref": "#/components/schemas/DateTimeUtc" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all tasks" }, "post": { "tags": [ "Tasks" ], "operationId": "tasks.create", "parameters": [ { "name": "allow_duplicate", "in": "query", "schema": { "type": "string", "enum": [ "true", "false", "True", "False" ] }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "Task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } }, "409": { "description": "DuplicateTaskError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateTaskError" } } } } }, "summary": "Create a new task", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "form_id", "employee_id" ], "properties": { "form_id": { "$ref": "#/components/schemas/FormId" }, "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, { "type": "null" } ] }, "placement_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/PlacementId" }, { "type": "null" } ] }, { "type": "null" } ] }, "expired_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_scheduled_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_allowed_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/tasks/{task_id}": { "get": { "tags": [ "Tasks" ], "operationId": "tasks.findById", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a task by ID" }, "patch": { "tags": [ "Tasks" ], "operationId": "tasks.updateById", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Forbidden" }, { "$ref": "#/components/schemas/ForbiddenError" } ] } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a task", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "expired_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_scheduled_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_allowed_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Tasks" ], "operationId": "tasks.deleteById", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a task" } }, "/api/v1/tasks/{task_id}/fields": { "get": { "tags": [ "Tasks" ], "operationId": "tasks.getFields", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true }, { "name": "include_sensitive_info", "in": "query", "schema": { "type": "string", "enum": [ "true", "false", "True", "False" ] }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "type": "object", "required": [ "type", "path", "label", "value" ], "properties": { "type": { "type": "string" }, "path": { "type": "string" }, "label": { "type": "object", "required": [ "en" ], "properties": { "en": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Label for the field, in english (if available)" } }, "additionalProperties": false }, "value": { "$id": "/schemas/any", "description": "The value of the field", "title": "any" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get task fields" }, "patch": { "tags": [ "Tasks" ], "operationId": "tasks.updateFields", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "null" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update task fields", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "fields": { "type": "array", "items": { "type": "object", "required": [ "path", "value" ], "properties": { "path": { "type": "string" }, "value": { "$id": "/schemas/any", "description": "The value of the field", "title": "any" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/tasks/{task_id}/pdf": { "get": { "tags": [ "Tasks" ], "operationId": "tasks.getPdf", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "a string", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Download task as PDF" } }, "/api/v1/tasks/{task_id}/onboarding": { "get": { "tags": [ "Tasks" ], "operationId": "tasks.getOnboardingUrl", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true }, { "name": "assignee_type", "in": "query", "schema": { "type": "string", "enum": [ "employee", "employer" ] }, "required": true }, { "name": "locale", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "redirect_to", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get onboarding URL for a task" } }, "/api/v1/jobs": { "get": { "tags": [ "Jobs" ], "operationId": "jobs.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "custom_attributes", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all jobs" }, "post": { "tags": [ "Jobs" ], "operationId": "jobs.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "address", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/JobId" }, "name": { "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Job" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a new job", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } } }, "/api/v1/jobs/{job_id}": { "get": { "tags": [ "Jobs" ], "operationId": "jobs.findById", "parameters": [ { "name": "job_id", "in": "path", "schema": { "$ref": "#/components/schemas/JobId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a job by ID" }, "patch": { "tags": [ "Jobs" ], "operationId": "jobs.updateById", "parameters": [ { "name": "job_id", "in": "path", "schema": { "$ref": "#/components/schemas/JobId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a job", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "delete": { "tags": [ "Jobs" ], "operationId": "jobs.deleteById", "parameters": [ { "name": "job_id", "in": "path", "schema": { "$ref": "#/components/schemas/JobId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a job" } }, "/api/v1/placements": { "get": { "tags": [ "Placements" ], "operationId": "placements.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "employee_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": false }, { "name": "employer_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": false }, { "name": "client_id", "in": "query", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": false }, { "name": "job_id", "in": "query", "schema": { "$ref": "#/components/schemas/JobId" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Placement" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all placements" }, "post": { "tags": [ "Placements" ], "operationId": "placements.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "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.", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "employee_id", "employer_id", "client_id", "job_id", "custom_attributes", "created_at", "missing_task_count", "progress", "form_requirements", "suggested_tasks" ], "properties": { "id": { "$ref": "#/components/schemas/PlacementId" }, "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "missing_task_count": { "type": "number" }, "progress": { "type": "object", "required": [ "forms_required", "forms_completed" ], "properties": { "forms_required": { "type": "number" }, "forms_completed": { "type": "number" } }, "additionalProperties": false }, "form_requirements": { "type": "array", "items": { "type": "object", "required": [ "task_id", "form", "form_id", "form_name", "form_tags" ], "properties": { "task_id": { "anyOf": [ { "$ref": "#/components/schemas/TaskId" }, { "type": "null" } ] }, "form": { "type": "object", "required": [ "id", "name", "tags", "custom_attributes" ], "properties": { "id": { "$ref": "#/components/schemas/FormId" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": false }, "form_id": { "$ref": "#/components/schemas/FormId" }, "form_name": { "type": "string" }, "form_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "suggested_tasks": { "type": "array", "items": { "type": "object", "required": [ "form_id", "form_name", "task_id", "form_tags" ], "properties": { "form_id": { "$ref": "#/components/schemas/FormId" }, "form_name": { "type": "string" }, "task_id": { "anyOf": [ { "$ref": "#/components/schemas/TaskId" }, { "type": "null" } ] }, "form_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } }, "409": { "description": "PlacementConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementConflictError" } } } } }, "summary": "Create a new placement", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "employee_id" ], "properties": { "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "create_tasks": { "type": "boolean" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } } }, "/api/v1/placements/{placement_id}": { "get": { "tags": [ "Placements" ], "operationId": "placements.findById", "parameters": [ { "name": "placement_id", "in": "path", "schema": { "$ref": "#/components/schemas/PlacementId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a placement by ID" }, "patch": { "tags": [ "Placements" ], "operationId": "placements.updateById", "parameters": [ { "name": "placement_id", "in": "path", "schema": { "$ref": "#/components/schemas/PlacementId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a placement", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "create_tasks": { "type": "boolean" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "delete": { "tags": [ "Placements" ], "operationId": "placements.deleteById", "parameters": [ { "name": "placement_id", "in": "path", "schema": { "$ref": "#/components/schemas/PlacementId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a placement" } }, "/api/v1/placements/preview": { "post": { "tags": [ "Placements" ], "operationId": "placements.preview", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "description": "Generate a transient placement to preview form requirements without creating it", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "employee_id" ], "properties": { "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" } } } }, "required": true } }, "get": { "tags": [ "Placements" ], "operationId": "placements.previewDeprecated", "parameters": [ { "name": "employee_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployeeId" }, "required": true }, { "name": "employer_id", "in": "query", "schema": { "$ref": "#/components/schemas/EmployerId" }, "required": false }, { "name": "client_id", "in": "query", "schema": { "$ref": "#/components/schemas/ClientId" }, "required": false }, { "name": "job_id", "in": "query", "schema": { "$ref": "#/components/schemas/JobId" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Placement" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "description": "DEPRECATED: Use POST /placements/preview instead", "deprecated": true } }, "/api/v1/placements/preview_tasks": { "post": { "tags": [ "Placements" ], "operationId": "placements.previewTasks", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "form_id", "name", "rules" ], "properties": { "form_id": { "$ref": "#/components/schemas/FormId" }, "name": { "type": "string" }, "rules": { "$id": "/schemas/unknown", "title": "unknown" } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "description": "DEPRECATED: Use POST /placements/preview instead", "deprecated": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "employee_id" ], "properties": { "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/themes": { "get": { "tags": [ "Themes" ], "operationId": "themes.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all themes" }, "post": { "tags": [ "Themes" ], "operationId": "themes.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Theme", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a new theme", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "a non empty string", "title": "nonEmptyString", "minLength": 1 }, "light": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false }, "dark": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/themes/{theme_id}": { "get": { "tags": [ "Themes" ], "operationId": "themes.findById", "parameters": [ { "name": "theme_id", "in": "path", "schema": { "$ref": "#/components/schemas/ThemeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Theme", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a theme by ID" }, "patch": { "tags": [ "Themes" ], "operationId": "themes.updateById", "parameters": [ { "name": "theme_id", "in": "path", "schema": { "$ref": "#/components/schemas/ThemeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Theme", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a theme", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "name": { "type": "string", "description": "a non empty string", "title": "nonEmptyString", "minLength": 1 }, "light": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false }, "dark": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Themes" ], "operationId": "themes.deleteById", "parameters": [ { "name": "theme_id", "in": "path", "schema": { "$ref": "#/components/schemas/ThemeId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Theme", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Theme" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a theme" } }, "/api/v1/custom_properties": { "get": { "tags": [ "Custom Properties" ], "operationId": "custom_properties.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "entity_type", "in": "query", "schema": { "type": "string", "enum": [ "employee", "employer", "placement", "form", "client", "job" ] }, "required": false }, { "name": "path", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "active", "deprecated" ] }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomProperty" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all custom properties" }, "post": { "tags": [ "Custom Properties" ], "operationId": "custom_properties.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "CustomProperty", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomProperty" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a custom property", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "label", "entity_type", "scalar_type" ], "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "employee", "employer", "placement", "form", "client", "job" ] }, "scalar_type": { "type": "string", "enum": [ "string", "boolean", "date", "datetime", "integer", "decimal", "address" ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/custom_properties/{custom_property_id}": { "get": { "tags": [ "Custom Properties" ], "operationId": "custom_properties.findById", "parameters": [ { "name": "custom_property_id", "in": "path", "schema": { "$ref": "#/components/schemas/CustomPropertyId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "CustomProperty", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomProperty" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a custom property by ID" }, "delete": { "tags": [ "Custom Properties" ], "operationId": "custom_properties.deleteById", "parameters": [ { "name": "custom_property_id", "in": "path", "schema": { "$ref": "#/components/schemas/CustomPropertyId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "CustomProperty", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomProperty" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a custom property" } }, "/api/v1/custom_properties/{custom_property_id}/deprecate": { "post": { "tags": [ "Custom Properties" ], "operationId": "custom_properties.deprecateById", "parameters": [ { "name": "custom_property_id", "in": "path", "schema": { "$ref": "#/components/schemas/CustomPropertyId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "CustomProperty", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomProperty" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Deprecate a custom property" } }, "/api/v1/magic_links": { "post": { "tags": [ "Magic Links" ], "operationId": "magic_links.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "expire_at", "redirect_path_deprecation_deadline", "redirect_path_deprecation_note" ], "properties": { "url": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/.+", "pattern": "^https?:\\/\\/.+" }, "expire_at": { "type": "string" }, "redirect_path_deprecation_deadline": { "type": "string", "format": "date-time", "description": "The date and time when the redirect_path parameter will become invalid and stop working" }, "redirect_path_deprecation_note": { "type": "string", "description": "Information about what to use instead of the deprecated redirect_path parameter" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Create a magic link", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "expire_in" ], "properties": { "user_email": { "type": "string", "format": "email" }, "user_external_id": { "type": "string", "description": "Custom identifier provided upon user creation. Can be provided with or without user_email. If user_email is omitted, however, this field must uniquely identify a user. An error will be returned if multiple users hold the same external_id." }, "expire_in": { "type": "integer", "description": "a number between 1 and 86400", "title": "between(1, 86400)", "minimum": 1, "maximum": 86400 }, "redirect_path": { "anyOf": [ { "$ref": "#/components/schemas/MagicLinkRedirectPath" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/subtasks/{subtask_id}": { "get": { "tags": [ "Subtasks" ], "operationId": "subtasks.findById", "parameters": [ { "name": "subtask_id", "in": "path", "schema": { "$ref": "#/components/schemas/SubtaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Subtask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subtask" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a subtask by ID" } }, "/api/v1/subtasks/{subtask_id}/upload": { "post": { "tags": [ "Subtasks" ], "operationId": "subtasks.uploadFiles", "parameters": [ { "name": "subtask_id", "in": "path", "schema": { "$ref": "#/components/schemas/SubtaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "UploadFilesResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadFilesResponse" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Upload files to a subtask", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/PersistedFile" } } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/tasks/{task_id}/task_change_requests": { "post": { "tags": [ "Task Change Requests" ], "operationId": "task_change_requests.create", "parameters": [ { "name": "task_id", "in": "path", "schema": { "$ref": "#/components/schemas/TaskId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "TaskChangeRequestSkipped", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskChangeRequestSkipped" } } } }, "201": { "description": "TaskChangeRequestCreated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskChangeRequestCreated" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Create a task change request", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "starting_section_id": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/users": { "get": { "tags": [ "Users" ], "operationId": "users.list", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "external_id", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "page", "in": "query", "schema": { "$ref": "#/components/schemas/NumberFromString" }, "required": false }, { "name": "per_page", "in": "query", "schema": { "$ref": "#/components/schemas/NumberFromString" }, "required": false } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all users" }, "post": { "tags": [ "Users" ], "operationId": "users.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/WorkosUserCreationError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Create a new user", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "user_group_ids" ], "properties": { "email": { "type": "string" }, "password": { "anyOf": [ { "type": "string", "description": "Password must be at least 8 characters and contain uppercase, lowercase, and numbers.", "title": "minLength(8)", "minLength": 8, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)" }, { "type": "null" } ] }, "email_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "user_group_ids": { "type": "array", "items": { "type": "string" } }, "external_id": { "anyOf": [ { "type": "string", "description": "Optional field to store a customer-provided identifier for the user. Onboarded does not validate uniqueness of this field. Customers who intend to use this field with magic links should ensure this field holds unique values." }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/users/{user_id}": { "get": { "tags": [ "Users" ], "operationId": "users.findById", "parameters": [ { "name": "user_id", "in": "path", "schema": { "$ref": "#/components/schemas/UserId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a user by ID" }, "patch": { "tags": [ "Users" ], "operationId": "users.updateById", "parameters": [ { "name": "user_id", "in": "path", "schema": { "$ref": "#/components/schemas/UserId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a user", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "external_id": { "anyOf": [ { "type": "string", "description": "Optional field to store a customer-provided identifier for the user. Onboarded does not validate uniqueness of this field. Customers who intend to use this field with magic links should ensure this field holds unique values." }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Users" ], "operationId": "users.deleteById", "parameters": [ { "name": "user_id", "in": "path", "schema": { "$ref": "#/components/schemas/UserId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/WorkosUserDeletionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a user" } }, "/api/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "operationId": "webhooks.list", "parameters": [ { "name": "page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 1000)", "description": "a number between 1 and 1000" }, "required": false, "description": "a number between 1 and 1000" }, { "name": "per_page", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/NumberFromString" } ], "title": "between(1, 100)", "description": "a number between 1 and 100" }, "required": false, "description": "a number between 1 and 100" } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "current_page", "per_page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "total": { "type": "number" }, "current_page": { "type": "number" }, "per_page": { "type": "number" }, "total_pages": { "type": "number" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "List all webhooks" }, "post": { "tags": [ "Webhooks" ], "operationId": "webhooks.create", "parameters": [], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "201": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequestError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } } }, "summary": "Create a new webhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "description": { "type": "string" }, "subscribed_events": { "type": "array", "items": { "type": "string", "enum": [ "employee.created", "employee.updated", "employee.deleted", "employer.created", "employer.updated", "employer.deleted", "client.created", "client.updated", "client.deleted", "job.created", "job.updated", "job.deleted", "task.created", "task.updated", "task.deleted", "task.form_pdf_generated", "placement.created", "placement.updated", "placement.deleted" ] } } }, "additionalProperties": false } } }, "required": true } } }, "/api/v1/webhooks/{webhook_id}": { "get": { "tags": [ "Webhooks" ], "operationId": "webhooks.findById", "parameters": [ { "name": "webhook_id", "in": "path", "schema": { "$ref": "#/components/schemas/WebhookId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Get a webhook by ID" }, "patch": { "tags": [ "Webhooks" ], "operationId": "webhooks.updateById", "parameters": [ { "name": "webhook_id", "in": "path", "schema": { "$ref": "#/components/schemas/WebhookId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Update a webhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "description": { "type": "string" }, "subscribed_events": { "type": "array", "items": { "type": "string", "enum": [ "employee.created", "employee.updated", "employee.deleted", "employer.created", "employer.updated", "employer.deleted", "client.created", "client.updated", "client.deleted", "job.created", "job.updated", "job.deleted", "task.created", "task.updated", "task.deleted", "task.form_pdf_generated", "placement.created", "placement.updated", "placement.deleted" ] } } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Webhooks" ], "operationId": "webhooks.deleteById", "parameters": [ { "name": "webhook_id", "in": "path", "schema": { "$ref": "#/components/schemas/WebhookId" }, "required": true } ], "security": [ { "user_session": [] }, { "form_session": [] }, { "component_session": [] }, { "component_token": [] }, { "api_token": [] } ], "responses": { "200": { "description": "Webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "ResourceNotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "summary": "Delete a webhook" } } }, "components": { "schemas": { "NumberFromString": { "type": "string", "description": "a string to be decoded into a number" }, "Client": { "type": "object", "required": [ "id", "name", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/ClientId" }, "name": { "type": "string" }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Client" }, "ScalarValueUnknown": { "$id": "/schemas/unknown", "description": "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.", "title": "ScalarValueUnknown" }, "ClientId": { "type": "string", "description": "Client Identifier", "title": "ClientId", "examples": [ "cl_abc123def456" ], "pattern": "^cl_" }, "CustomAttributes": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "Record of custom attribute values keyed by string path.", "title": "CustomAttributes" }, "DateTimeUtc": { "type": "string", "description": "a string to be decoded into a DateTime.Utc" }, "HttpApiDecodeError": { "type": "object", "required": [ "issues", "message", "_tag" ], "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "HttpApiDecodeError" ] } }, "additionalProperties": false, "description": "The request did not match the expected schema" }, "Issue": { "type": "object", "required": [ "_tag", "path", "message" ], "properties": { "_tag": { "type": "string", "enum": [ "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden" ], "description": "The tag identifying the type of parse issue" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyKey" }, "description": "The path to the property where the issue occurred" }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } }, "additionalProperties": false, "description": "Represents an error encountered while parsing a value to match the schema" }, "PropertyKey": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "required": [ "_tag", "key" ], "properties": { "_tag": { "type": "string", "enum": [ "symbol" ] }, "key": { "type": "string" } }, "additionalProperties": false, "description": "an object to be decoded into a globally shared symbol" } ] }, "BadRequestError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "BadRequestError" ] } }, "additionalProperties": false }, "Unauthorized": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Unauthorized" ] } }, "additionalProperties": false }, "Forbidden": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Forbidden" ] } }, "additionalProperties": false }, "ResourceNotFoundError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ResourceNotFoundError" ] } }, "additionalProperties": false }, "EmployeeId": { "type": "string", "description": "Employee Identifier", "title": "EmployeeId", "examples": [ "ee_abc123def456" ], "pattern": "^ee_" }, "ConnectedOrganization": { "type": "object", "required": [ "id", "name", "dba_name", "ein", "business_email", "candidate_support_email", "phone", "live_account_id", "test_account_id", "default_language", "supported_languages", "address", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "business_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "candidate_support_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "live_account_id": { "type": "string" }, "test_account_id": { "type": "string" }, "default_language": { "anyOf": [ { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] }, { "type": "null" } ] }, "supported_languages": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu" ] } }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "object", "required": [ "street", "secondary", "city", "state", "zip", "country", "full_address" ], "properties": { "street": { "type": "string" }, "secondary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "type": "string", "enum": [ "AND", "ARE", "ATG", "AIA", "ALB", "ARM", "AGO", "ATA", "ARG", "ASM", "AUT", "AUS", "ABW", "ALA", "AZE", "BIH", "BRB", "BGD", "BEL", "BFA", "BGR", "BHR", "BDI", "BEN", "BLM", "BMU", "BRN", "BOL", "BES", "BRA", "BHS", "BTN", "BVT", "BWA", "BLR", "BLZ", "CAN", "CCK", "COD", "CAF", "COG", "CHE", "CIV", "COK", "CHL", "CHN", "CMR", "COL", "CRI", "CPV", "CUW", "CXR", "CYP", "CZE", "DEU", "DJI", "DNK", "DMA", "DOM", "DZA", "ECU", "EST", "EGY", "ESH", "ERI", "ESP", "ETH", "FIN", "FJI", "FLK", "FSM", "FRO", "FRA", "GAB", "GBR", "GRD", "GEO", "GUF", "GGY", "GHA", "GIB", "GRL", "GMB", "GIN", "GLP", "GNQ", "GRC", "SGS", "GTM", "GUM", "GNB", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IRL", "ISR", "IMN", "IND", "IOT", "IRQ", "ISL", "ITA", "JEY", "JAM", "JOR", "JPN", "KEN", "KGZ", "KHM", "KIR", "COM", "KNA", "KOR", "KWT", "CYM", "KAZ", "LAO", "LBN", "LCA", "LIE", "LKA", "LBR", "LSO", "LTU", "LUX", "LVA", "LBY", "MAR", "MCO", "MDA", "MNE", "MAF", "MDG", "MHL", "MKD", "MLI", "MMR", "MNG", "MAC", "MNP", "MTQ", "MRT", "MSR", "MLT", "MUS", "MDV", "MWI", "MEX", "MYS", "MOZ", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NLD", "NOR", "NPL", "NRU", "NIU", "NZL", "OMN", "PAN", "PER", "PYF", "PNG", "PHL", "PAK", "POL", "SPM", "PCN", "PRI", "PSE", "PRT", "PLW", "PRY", "QAT", "REU", "ROU", "SRB", "RUS", "RWA", "SAU", "SLB", "SYC", "SWE", "SGP", "SHN", "SVN", "SJM", "SVK", "SLE", "SMR", "SEN", "SOM", "SUR", "SSD", "STP", "SLV", "SXM", "SWZ", "TCA", "TCD", "ATF", "TGO", "THA", "TJK", "TKL", "TLS", "TKM", "TUN", "TON", "TUR", "TTO", "TUV", "TWN", "TZA", "UKR", "UGA", "UMI", "USA", "URY", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "MYT", "ZAF", "ZMB", "ZWE" ] }, "full_address": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "trial_end_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": false, "title": "ConnectedOrganization" }, "Employee": { "type": "object", "required": [ "id", "first_name", "last_name", "email", "phone", "date_of_birth", "social_security_number", "has_middle_name", "address", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/EmployeeId" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "social_security_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_middle_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "An employee 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 employee schema.", "title": "Employee" }, "Address": { "type": "object", "required": [ "street", "city", "state", "country" ], "properties": { "street": { "type": "string", "examples": [ "123 Main St" ] }, "secondary": { "anyOf": [ { "type": "string", "examples": [ "Suite 100" ] }, { "type": "null" } ] }, "city": { "type": "string", "examples": [ "San Francisco" ] }, "state": { "type": "string", "examples": [ "CA" ] }, "zip": { "anyOf": [ { "type": "string", "examples": [ "94102" ] }, { "type": "null" } ] }, "country": { "type": "string", "examples": [ "US" ] }, "full_address": { "anyOf": [ { "type": "string", "examples": [ "123 Main St, San Francisco, CA 94102" ] }, { "type": "null" } ] } }, "additionalProperties": false, "description": "An address resource" }, "Employer": { "type": "object", "required": [ "id", "name", "ein", "dba_name", "phone", "employee_count", "entity_structure", "naics_code", "address", "custom_attributes", "active_theme_id", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/EmployerId" }, "name": { "type": "string" }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dba_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "entity_structure": { "anyOf": [ { "type": "string", "enum": [ "sole_proprietorship", "partnership", "llc", "corporation", "nonprofit", "cooperative", "professional_corporation" ], "description": "Legal entity structure of the employer", "title": "EntityStructure" }, { "type": "null" } ] }, "naics_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "active_theme_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "An employer 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 employer schema.", "title": "Employer" }, "EmployerId": { "type": "string", "description": "Employer Identifier", "title": "EmployerId", "examples": [ "er_abc123def456" ], "pattern": "^er_" }, "FileId": { "type": "string", "description": "File Identifier", "examples": [ "file_abc123def456" ] }, "FileResponse": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Signed URL to the file, expires in 5 minutes" } }, "additionalProperties": false }, "Form": { "type": "object", "required": [ "id", "name", "task_reuse_criteria", "custom_attributes", "tags", "form_pages" ], "properties": { "id": { "$ref": "#/components/schemas/FormId" }, "name": { "type": "string", "description": "The name of the form" }, "task_reuse_criteria": { "type": "array", "items": { "type": "string" }, "description": "Criteria that determine when a new task is created vs reusing an existing one. Values include \"employer\", \"client\", \"job\", or a placement custom attribute path (e.g. \"placement.custom_attributes.location\").", "examples": [ [ "employer", "client" ] ] }, "custom_attributes": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/any", "title": "any" } }, "tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } }, "form_pages": { "type": "array", "items": { "type": "object", "required": [ "id", "description", "assignee_type", "form_section", "form_fields" ], "properties": { "id": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assignee_type": { "type": "string", "enum": [ "employee", "employer", "system" ] }, "form_section": { "anyOf": [ { "type": "object", "required": [ "id", "position", "assignee_type" ], "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "assignee_type": { "type": "string", "enum": [ "employee", "employer", "system" ] } }, "additionalProperties": false }, { "type": "null" } ] }, "form_fields": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "path", "rule", "required" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "path": { "type": "string" }, "rule": { "$id": "/schemas/unknown", "title": "unknown" }, "required": { "type": "boolean" }, "translations": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "string" } } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false }, "FormId": { "type": "string", "description": "Form Identifier (lineage uid)", "examples": [ "tlin_abc123def456" ] }, "JobId": { "type": "string", "description": "Job Identifier", "title": "JobId", "examples": [ "job_abc123def456" ], "pattern": "^job_" }, "Task": { "type": "object", "required": [ "id", "form_id", "form_custom_attributes", "name", "employee_id", "employer_id", "client_id", "job_id", "status", "next_action", "expired_at", "deletion_scheduled_at", "deletion_allowed_at", "due_at", "completed_at", "progress", "subtasks", "tags", "created_at", "updated_at", "_tag" ], "properties": { "id": { "$ref": "#/components/schemas/TaskId" }, "form_id": { "$ref": "#/components/schemas/FormId" }, "form_custom_attributes": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/any", "title": "any" } }, "name": { "type": "string", "description": "The name of the form" }, "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "requires_action", "completed", "expired" ] }, "next_action": { "type": "object", "required": [ "type" ], "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "employer_action", "employee_action", "system_action" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "expired_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_scheduled_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "deletion_allowed_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "due_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "completed_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ], "description": "This field is set when the task status changes to completed." }, "progress": { "type": "object", "required": [ "percent", "numerator", "denominator" ], "properties": { "percent": { "type": "number" }, "numerator": { "type": "number" }, "denominator": { "type": "number" } }, "additionalProperties": false }, "subtasks": { "type": "array", "items": { "type": "object", "required": [ "id", "form_page_id", "assignee_type", "form_section", "progress" ], "properties": { "id": { "type": "string" }, "form_page_id": { "type": "string" }, "assignee_type": { "type": "string", "enum": [ "employee", "employer" ] }, "form_section": { "anyOf": [ { "type": "object", "required": [ "id", "position", "assignee_type" ], "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "assignee_type": { "type": "string", "enum": [ "employee", "employer", "system" ] } }, "additionalProperties": false }, { "type": "null" } ] }, "progress": { "type": "object", "required": [ "percent", "numerator", "denominator" ], "properties": { "percent": { "type": "number" }, "numerator": { "type": "number" }, "denominator": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "_tag": { "type": "string", "enum": [ "Task" ] } }, "additionalProperties": false }, "TaskId": { "type": "string", "description": "Task Identifier", "title": "TaskId", "examples": [ "task_abc123def456" ], "pattern": "^task_" }, "DuplicateTaskError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "DuplicateTaskError" ] } }, "additionalProperties": false }, "ForbiddenError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ForbiddenError" ] } }, "additionalProperties": false }, "Job": { "type": "object", "required": [ "id", "name", "address", "custom_attributes", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/JobId" }, "name": { "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Job" }, "Placement": { "type": "object", "required": [ "id", "employee_id", "employer_id", "client_id", "job_id", "custom_attributes", "created_at", "missing_task_count", "progress", "form_requirements", "suggested_tasks" ], "properties": { "id": { "$ref": "#/components/schemas/PlacementId" }, "employee_id": { "$ref": "#/components/schemas/EmployeeId" }, "employer_id": { "anyOf": [ { "$ref": "#/components/schemas/EmployerId" }, { "type": "null" } ] }, "client_id": { "anyOf": [ { "$ref": "#/components/schemas/ClientId" }, { "type": "null" } ] }, "job_id": { "anyOf": [ { "$ref": "#/components/schemas/JobId" }, { "type": "null" } ] }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "missing_task_count": { "type": "number" }, "progress": { "type": "object", "required": [ "forms_required", "forms_completed" ], "properties": { "forms_required": { "type": "number" }, "forms_completed": { "type": "number" } }, "additionalProperties": false }, "form_requirements": { "type": "array", "items": { "type": "object", "required": [ "task_id", "form", "form_id", "form_name", "form_tags" ], "properties": { "task_id": { "anyOf": [ { "$ref": "#/components/schemas/TaskId" }, { "type": "null" } ] }, "form": { "type": "object", "required": [ "id", "name", "tags", "custom_attributes" ], "properties": { "id": { "$ref": "#/components/schemas/FormId" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } }, "custom_attributes": { "$ref": "#/components/schemas/CustomAttributes" } }, "additionalProperties": false }, "form_id": { "$ref": "#/components/schemas/FormId" }, "form_name": { "type": "string" }, "form_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "suggested_tasks": { "type": "array", "items": { "type": "object", "required": [ "form_id", "form_name", "task_id", "form_tags" ], "properties": { "form_id": { "$ref": "#/components/schemas/FormId" }, "form_name": { "type": "string" }, "task_id": { "anyOf": [ { "$ref": "#/components/schemas/TaskId" }, { "type": "null" } ] }, "form_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": { "$ref": "#/components/schemas/ScalarValueUnknown" }, "description": "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.", "title": "Placement" }, "PlacementId": { "type": "string", "description": "Placement Identifier", "title": "PlacementId", "examples": [ "pla_abc123def456" ], "pattern": "^pla_" }, "PlacementConflictError": { "type": "object", "required": [ "message", "meta", "_tag" ], "properties": { "message": { "type": "string" }, "meta": { "type": "object", "required": [ "placementId" ], "properties": { "placementId": { "$ref": "#/components/schemas/PlacementId" } }, "additionalProperties": false }, "_tag": { "type": "string", "enum": [ "PlacementConflictError" ] } }, "additionalProperties": false }, "Theme": { "type": "object", "required": [ "id", "name", "created_at", "updated_at", "_tag" ], "properties": { "id": { "$ref": "#/components/schemas/ThemeId" }, "name": { "type": "string", "description": "a non empty string", "title": "nonEmptyString", "minLength": 1 }, "light": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false }, "dark": { "type": "object", "required": [], "properties": { "logo": { "type": "string" }, "show_header": { "type": "boolean" }, "show_form_name": { "type": "boolean" }, "show_updated_fields_count": { "type": "boolean" }, "next_button_text": { "type": "string" }, "back_button_text": { "type": "string" }, "custom_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "custom_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "primary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_background": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "secondary_foreground": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "progress": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "border": { "type": "string", "description": "Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)", "title": "ThemeColor", "examples": [ "#FFF", "#FFFFFF" ], "pattern": "^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "radius": { "type": "string" } }, "additionalProperties": false }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "_tag": { "type": "string", "enum": [ "Theme" ] } }, "additionalProperties": false }, "ThemeId": { "type": "string", "description": "Theme Identifier", "title": "ThemeId", "examples": [ "theme_abc123def456" ], "pattern": "^theme_" }, "CustomProperty": { "type": "object", "required": [ "id", "name", "label", "entity_type", "scalar_type", "path", "is_sensitive_info", "is_permission_scope", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/CustomPropertyId" }, "name": { "type": "string" }, "label": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "employee", "employer", "placement", "form", "client", "job" ] }, "scalar_type": { "type": "string", "enum": [ "string", "boolean", "date", "datetime", "integer", "decimal", "address" ] }, "path": { "type": "string" }, "is_sensitive_info": { "type": "boolean" }, "is_permission_scope": { "type": "boolean" }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": false }, "CustomPropertyId": { "type": "string", "description": "Custom Property Identifier", "title": "CustomPropertyId", "examples": [ "cprop_abc123def456" ], "pattern": "^cprop_" }, "MagicLinkRedirectPath": { "type": "string", "description": "Optional redirect path within the dashboard (must be a relative path starting with '/' and cannot contain external URLs). Examples: /dashboard, /employees/ee_123" }, "SubtaskId": { "type": "string", "description": "Subtask Identifier", "title": "SubtaskId", "examples": [ "subtask_abc123def456" ], "pattern": "^subtask_" }, "Subtask": { "type": "object", "required": [ "id", "form_page_id", "data" ], "properties": { "id": { "type": "string", "description": "Subtask ID" }, "form_page_id": { "type": "string", "description": "Form page ID associated with this subtask" }, "data": { "$id": "/schemas/any", "description": "Subtask data", "title": "any" } }, "additionalProperties": false }, "PersistedFile": { "type": "string", "format": "binary" }, "UploadFilesResponse": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/UploadedFile" } } }, "additionalProperties": false }, "UploadedFile": { "type": "object", "required": [ "id", "key", "name", "type", "size", "checksum" ], "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "number" }, "checksum": { "type": "string" } }, "additionalProperties": false }, "TaskChangeRequestCreated": { "type": "object", "required": [ "_tag" ], "properties": { "_tag": { "type": "string", "enum": [ "created" ] } }, "additionalProperties": false }, "TaskChangeRequestSkipped": { "type": "object", "required": [ "_tag" ], "properties": { "_tag": { "type": "string", "enum": [ "skipped" ] } }, "additionalProperties": false }, "User": { "type": "object", "required": [ "id", "email", "external_id", "created_at", "updated_at" ], "properties": { "id": { "$ref": "#/components/schemas/UserId" }, "email": { "type": "string" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" } }, "additionalProperties": false }, "UserId": { "type": "string", "description": "User Identifier", "title": "UserId", "examples": [ "user_abc123def456" ], "pattern": "^user_" }, "WorkosUserCreationError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "WorkosUserCreationError" ] } }, "additionalProperties": false }, "WorkosUserDeletionError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "WorkosUserDeletionError" ] } }, "additionalProperties": false }, "Webhook": { "type": "object", "required": [ "id", "url", "token", "description", "created_at", "updated_at", "last_used_at", "subscribed_events" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookId" }, "url": { "type": "string" }, "token": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "updated_at": { "$ref": "#/components/schemas/DateTimeUtc" }, "last_used_at": { "anyOf": [ { "$ref": "#/components/schemas/DateTimeUtc" }, { "type": "null" } ] }, "subscribed_events": { "type": "array", "items": { "type": "string", "enum": [ "employee.created", "employee.updated", "employee.deleted", "employer.created", "employer.updated", "employer.deleted", "client.created", "client.updated", "client.deleted", "job.created", "job.updated", "job.deleted", "task.created", "task.updated", "task.deleted", "task.form_pdf_generated", "placement.created", "placement.updated", "placement.deleted" ] } } }, "additionalProperties": false }, "WebhookId": { "type": "string", "description": "Webhook Identifier", "title": "WebhookId", "examples": [ "we_abc123def456" ], "pattern": "^we_" } }, "securitySchemes": { "user_session": { "type": "apiKey", "name": "__session", "in": "cookie" }, "form_session": { "type": "http", "scheme": "bearer" }, "component_session": { "type": "apiKey", "name": "__component", "in": "cookie" }, "component_token": { "type": "apiKey", "name": "x-component-auth-token", "in": "header" }, "api_token": { "type": "http", "scheme": "bearer" } } }, "security": [], "tags": [ { "name": "Clients", "description": "API for managing clients" }, { "name": "Components", "description": "API for creating embeddable component URLs" }, { "name": "Connected Organizations", "description": "API for managing connected organizations and their configuration" }, { "name": "Employees", "description": "API for managing employees" }, { "name": "Employers", "description": "API for managing employers" }, { "name": "Files", "description": "API for accessing uploaded files" }, { "name": "Forms", "description": "API for accessing forms" }, { "name": "Tasks", "description": "API for managing tasks" }, { "name": "Jobs", "description": "API for managing jobs" }, { "name": "Placements", "description": "API for managing placements" }, { "name": "Themes", "description": "API for managing themes" }, { "name": "Custom Properties", "description": "API for managing custom properties" }, { "name": "Magic Links", "description": "API for creating magic links for user authentication" }, { "name": "Subtasks", "description": "Subtask management and file upload API" }, { "name": "Task Change Requests", "description": "API for requesting changes to completed tasks" }, { "name": "Users", "description": "API for managing users" }, { "name": "Webhooks", "description": "API for managing webhooks" } ], "servers": [ { "url": "https://app.onboarded.com", "description": "Onboarded Production Server" } ] }