{ "openapi": "3.1.0", "info": { "title": "ASHR.work Public API", "version": "1.0.0", "description": "Public API for ASHR.work. Product & module metadata is anonymous-first; tenant data (read + write) requires either a Demystify API key (Bearer dmk_live_/dmk_test_) or an OAuth2 access token (Bearer dmk_at_) carrying the endpoint’s scope — the two are interchangeable everywhere — and every query is isolated to the credential’s tenant. Errors are RFC 9457 problem+json; list responses use a { data, next_cursor, has_more } envelope; writes accept Idempotency-Key; every response carries X-Request-Id.", "contact": { "name": "ASHR.work support", "email": "support@ashr.work", "url": "https://ashr.work/for-agents" }, "license": { "name": "Proprietary" } }, "servers": [ { "url": "https://ashr.work/api", "description": "Production" } ], "security": [ {}, { "apiKey": [] }, { "oauth2": [] } ], "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "dmk_live_/dmk_test_", "description": "Demystify API key. Interchangeable with an OAuth2 access token on every authenticated endpoint." }, "oauth2": { "type": "oauth2", "description": "OAuth2 client-credentials (with refresh). Tokens are Bearer dmk_at_… and carry the intersection of requested and client scopes.", "flows": { "clientCredentials": { "tokenUrl": "https://ashr.work/api/oauth/token", "scopes": {} } } } }, "schemas": { "Module": { "type": "object", "properties": { "slug": { "type": "string", "example": "leave-management" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "beta", "coming-soon" ] }, "availability": { "type": "string", "enum": [ "available", "beta", "customizable-on-request" ] }, "category": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "slug", "title", "description", "status", "availability", "category", "url" ] }, "Problem": { "type": "object", "description": "RFC 9457 problem document", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "type", "title", "status", "code" ] }, "Health": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "product": { "type": "string" }, "time": { "type": "string" } } } } }, "paths": { "/v1/health": { "get": { "summary": "Health check", "operationId": "getHealth", "tags": [ "System" ], "responses": { "200": { "description": "Service healthy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/capabilities": { "get": { "summary": "Full capabilities manifest", "operationId": "getCapabilities", "tags": [ "Discovery" ], "responses": { "200": { "description": "Capabilities", "content": { "application/json": { "schema": { "type": "object" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/modules": { "get": { "summary": "List modules", "operationId": "listModules", "tags": [ "Modules" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "available", "beta", "coming-soon" ] } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of modules", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Module" } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid query parameter", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid API key or access token", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/modules/{slug}": { "get": { "summary": "Get one module", "operationId": "getModule", "tags": [ "Modules" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The module", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Module" } } } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } } }, "404": { "description": "No module with that slug", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/whoami": { "get": { "summary": "Identify the current credential", "operationId": "whoami", "tags": [ "System" ], "description": "Returns the presented credential’s id, environment, granted scopes and kind. Accepts an API key or an OAuth2 access token; requires a valid one, but no particular scope.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "responses": { "200": { "description": "Credential identity", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "key_id": { "type": "string" }, "env": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "credential": { "type": "string", "enum": [ "api_key", "oauth_access_token" ] } } } } } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/employees": { "get": { "summary": "List employees", "operationId": "list_employees", "tags": [ "employees" ], "description": "Employees (tenant-scoped). Tenant-scoped to the credential's tenant. Requires scope `employees:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of employees", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "employee_id": {}, "profile_id": {}, "manager_id": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } }, "post": { "summary": "Create an employee", "operationId": "createEmployee", "tags": [ "employees" ], "description": "Create an employee with a login, running the same journey as the app: provisions their account, inserts the employee record (the employee code is assigned automatically unless you supply one, and leave balances are seeded), optionally records a payout rate card, and emails them an invite. Counts against the tenant’s plan seats. Requires scope `employees:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id", "email", "full_name", "joining_date" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "email": { "type": "string", "format": "email" }, "full_name": { "type": "string" }, "joining_date": { "type": "string", "example": "2026-09-01", "description": "YYYY-MM-DD" }, "employee_id": { "type": "string", "description": "Employee code. Omit to let the tenant’s ID format assign the next one." }, "department": { "type": "string" }, "designation": { "type": "string" }, "phone": { "type": "string" }, "employment_type": { "type": "string", "enum": [ "full_time", "part_time", "intern", "contractor", "freelancer", "vendor_worker" ] }, "engagement_end_date": { "type": "string", "example": "2027-03-31" }, "vendor_name": { "type": "string", "description": "Required for vendor_worker." }, "pay_model": { "type": "string", "enum": [ "hourly", "monthly_fee", "per_engagement" ], "description": "Payout types only." }, "rate": { "type": "number", "description": "Payout types only; paired with pay_model." } } } } } }, "responses": { "200": { "description": "Employee created", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/employees/{id}": { "get": { "summary": "Get one employees", "operationId": "get_employees", "tags": [ "employees" ], "description": "Employees (tenant-scoped). Tenant-scoped. Requires scope `employees:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The employees", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "employee_id": {}, "profile_id": {}, "manager_id": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } }, "patch": { "summary": "Update an employee", "operationId": "updateEmployee", "tags": [ "employees" ], "description": "Update the HR-controlled employment fields (designation, department) of one employee. Supply at least one field; `null` clears it. An id outside the credential’s tenant is a 404, never a 403. Requires scope `employees:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "designation": { "type": [ "string", "null" ] }, "department": { "type": [ "string", "null" ] } } } } } }, "responses": { "200": { "description": "Employee updated", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-requests": { "get": { "summary": "List leave-requests", "operationId": "list_leave_requests", "tags": [ "leave-requests" ], "description": "Leave requests. Tenant-scoped to the credential's tenant. Requires scope `leave:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of leave-requests", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "employee_id": {}, "leave_type_id": {}, "start_date": {}, "end_date": {}, "days_count": {}, "status": {}, "reason": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } }, "post": { "summary": "Apply for leave", "operationId": "createLeaveRequest", "tags": [ "leave-requests" ], "description": "File a leave request for an employee, reusing the same core logic (balance, overlap, notifications) as the app. Requires scope `leave:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "employee_id", "leave_type_id", "start_date", "end_date", "days_count", "reason" ], "properties": { "employee_id": { "type": "string", "format": "uuid" }, "leave_type_id": { "type": "string", "format": "uuid" }, "start_date": { "type": "string", "example": "2026-09-01" }, "end_date": { "type": "string", "example": "2026-09-03" }, "days_count": { "type": "number", "example": 3 }, "reason": { "type": "string" }, "leave_duration": { "type": "string", "enum": [ "full_day", "half_day_morning", "half_day_afternoon" ] } } } } } }, "responses": { "200": { "description": "Leave request created", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-requests/{id}": { "get": { "summary": "Get one leave-requests", "operationId": "get_leave_requests", "tags": [ "leave-requests" ], "description": "Leave requests. Tenant-scoped. Requires scope `leave:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The leave-requests", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "employee_id": {}, "leave_type_id": {}, "start_date": {}, "end_date": {}, "days_count": {}, "status": {}, "reason": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-types": { "get": { "summary": "List leave-types", "operationId": "list_leave_types", "tags": [ "leave-types" ], "description": "Leave types configured for the tenant. Tenant-scoped to the credential's tenant. Requires scope `leave:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of leave-types", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "name": {}, "code": {}, "is_paid": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-types/{id}": { "get": { "summary": "Get one leave-types", "operationId": "get_leave_types", "tags": [ "leave-types" ], "description": "Leave types configured for the tenant. Tenant-scoped. Requires scope `leave:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The leave-types", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "name": {}, "code": {}, "is_paid": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/holidays": { "get": { "summary": "List holidays", "operationId": "list_holidays", "tags": [ "holidays" ], "description": "Holiday calendar. Tenant-scoped to the credential's tenant. Requires scope `holidays:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of holidays", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "date": {}, "name": {}, "type": {}, "year": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/holidays/{id}": { "get": { "summary": "Get one holidays", "operationId": "get_holidays", "tags": [ "holidays" ], "description": "Holiday calendar. Tenant-scoped. Requires scope `holidays:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The holidays", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "date": {}, "name": {}, "type": {}, "year": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/assets": { "get": { "summary": "List assets", "operationId": "list_assets", "tags": [ "assets" ], "description": "Asset register. Tenant-scoped to the credential's tenant. Requires scope `assets:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of assets", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "name": {}, "asset_tag": {}, "category_id": {}, "status": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/assets/{id}": { "get": { "summary": "Get one assets", "operationId": "get_assets", "tags": [ "assets" ], "description": "Asset register. Tenant-scoped. Requires scope `assets:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The assets", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "name": {}, "asset_tag": {}, "category_id": {}, "status": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/job-openings": { "get": { "summary": "List job-openings", "operationId": "list_job_openings", "tags": [ "job-openings" ], "description": "Recruitment job openings. Tenant-scoped to the credential's tenant. Requires scope `recruitment:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of job-openings", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "title": {}, "department": {}, "location": {}, "status": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } }, "post": { "summary": "Create a job opening", "operationId": "createJobOpening", "tags": [ "job-openings" ], "description": "Open a requisition, running the same journey as the app: if the tenant requires requisition approval the opening starts `pending`, otherwise `approved`. It is NOT published to the public career page — publishing stays a deliberate in-app act. Requires scope `recruitment:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id", "title", "employment_type", "openings_count" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "title": { "type": "string", "maxLength": 120 }, "employment_type": { "type": "string", "enum": [ "full_time", "part_time", "intern", "contractor", "freelancer", "vendor_worker" ] }, "openings_count": { "type": "integer", "minimum": 1, "maximum": 500 }, "department": { "type": "string" }, "location": { "type": "string" }, "description": { "type": "string" }, "hiring_manager_id": { "type": [ "string", "null" ], "format": "uuid", "description": "A profile id in the credential’s tenant. One from another tenant is a 404." }, "status": { "type": "string", "enum": [ "draft", "open" ], "default": "open" } } } } } }, "responses": { "200": { "description": "Job opening created", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/job-openings/{id}": { "get": { "summary": "Get one job-openings", "operationId": "get_job_openings", "tags": [ "job-openings" ], "description": "Recruitment job openings. Tenant-scoped. Requires scope `recruitment:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The job-openings", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "title": {}, "department": {}, "location": {}, "status": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } }, "patch": { "summary": "Update a job opening", "operationId": "updateJobOpening", "tags": [ "job-openings" ], "description": "Update a requisition, including closing it (`status: \"closed\"`, which stamps `closed_at`). Supply at least one field. An id outside the credential’s tenant is a 404, never a 403. Requires scope `recruitment:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "title": { "type": "string", "maxLength": 120 }, "employment_type": { "type": "string", "enum": [ "full_time", "part_time", "intern", "contractor", "freelancer", "vendor_worker" ] }, "openings_count": { "type": "integer", "minimum": 1, "maximum": 500 }, "department": { "type": "string" }, "location": { "type": "string" }, "description": { "type": "string" }, "hiring_manager_id": { "type": [ "string", "null" ], "format": "uuid", "description": "A profile id in the credential’s tenant. One from another tenant is a 404." }, "status": { "type": "string", "enum": [ "draft", "open", "on_hold", "closed" ] } } } } } }, "responses": { "200": { "description": "Job opening updated", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/helpdesk-tickets": { "get": { "summary": "List helpdesk-tickets", "operationId": "list_helpdesk_tickets", "tags": [ "helpdesk-tickets" ], "description": "Helpdesk tickets. Tenant-scoped to the credential's tenant. Requires scope `helpdesk:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of helpdesk-tickets", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "ticket_no": {}, "subject": {}, "status": {}, "priority": {}, "category_id": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/helpdesk-tickets/{id}": { "get": { "summary": "Get one helpdesk-tickets", "operationId": "get_helpdesk_tickets", "tags": [ "helpdesk-tickets" ], "description": "Helpdesk tickets. Tenant-scoped. Requires scope `helpdesk:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The helpdesk-tickets", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "ticket_no": {}, "subject": {}, "status": {}, "priority": {}, "category_id": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/surveys": { "get": { "summary": "List surveys", "operationId": "list_surveys", "tags": [ "surveys" ], "description": "Surveys. Tenant-scoped to the credential's tenant. Requires scope `surveys:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from next_cursor" } ], "responses": { "200": { "description": "A page of surveys", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "title": {}, "status": {}, "type": {}, "created_at": {} } } }, "next_cursor": { "type": [ "string", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid cursor", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/surveys/{id}": { "get": { "summary": "Get one surveys", "operationId": "get_surveys", "tags": [ "surveys" ], "description": "Surveys. Tenant-scoped. Requires scope `surveys:read`.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The surveys", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": {}, "title": {}, "status": {}, "type": {}, "created_at": {} } } } } } } }, "400": { "description": "Malformed id", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-requests/{id}/approve": { "post": { "summary": "Approve a leave request", "operationId": "approveLeaveRequest", "tags": [ "leave-requests" ], "description": "Approve a leave request. Requires scope `leave:approve`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid" }, "comment": { "type": "string" } } } } } }, "responses": { "200": { "description": "Action applied", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-requests/{id}/reject": { "post": { "summary": "Reject a leave request", "operationId": "rejectLeaveRequest", "tags": [ "leave-requests" ], "description": "Reject a leave request. Requires scope `leave:approve`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id", "reason" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid" }, "reason": { "type": "string" } } } } } }, "responses": { "200": { "description": "Action applied", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/leave-requests/{id}/cancel": { "post": { "summary": "Cancel a leave request", "operationId": "cancelLeaveRequest", "tags": [ "leave-requests" ], "description": "Cancel a leave request. Requires scope `leave:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": {} } } } }, "responses": { "200": { "description": "Action applied", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/documents": { "post": { "summary": "Generate a document", "operationId": "createDocument", "tags": [ "documents" ], "description": "Generate a letter from one of the tenant’s document templates for an employee OR a recruitment candidate (exactly one), storing it and notifying an employee recipient. Merge fields are filled from the record and the letterhead; `values` overrides any of them, and `content_override` replaces the rendered body verbatim. Requires scope `documents:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id", "template_id", "title" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "template_id": { "type": "string", "format": "uuid" }, "employee_id": { "type": "string", "format": "uuid", "description": "Exactly one of employee_id or candidate_id." }, "candidate_id": { "type": "string", "format": "uuid", "description": "Exactly one of employee_id or candidate_id." }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Merge-field overrides." }, "content_override": { "type": "string", "description": "Use this text verbatim instead of rendering the template." } } } } } }, "responses": { "200": { "description": "Document generated", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/candidates": { "post": { "summary": "Add a candidate", "operationId": "createCandidate", "tags": [ "candidates" ], "description": "Add a candidate to an OPEN role’s pipeline. They land in the tenant’s first active pipeline stage, exactly as from the app; a closed or on-hold role is refused. `resume_url` takes a link you already host — this API has no binary upload contract. Requires scope `recruitment:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id", "job_id", "full_name", "source" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "job_id": { "type": "string", "format": "uuid", "description": "An open job opening in the credential’s tenant." }, "full_name": { "type": "string", "maxLength": 120 }, "source": { "type": "string", "enum": [ "referral", "linkedin", "job_board", "agency", "career_page", "walk_in", "other" ] }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "current_company": { "type": "string" }, "expected_ctc": { "type": [ "number", "null" ] }, "resume_url": { "type": "string", "format": "uri", "description": "A link you host. No file upload contract exists yet." }, "notes": { "type": "string" } } } } } }, "responses": { "200": { "description": "Candidate added", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } }, "/v1/candidates/{id}": { "patch": { "summary": "Move or restatus a candidate", "operationId": "updateCandidate", "tags": [ "candidates" ], "description": "Move a candidate to another pipeline stage, OR change their status — exactly one of `stage_id` and `status` per request, because applying both would need an ordering rule the product does not have. `status: \"rejected\"` requires `rejection_reason`. Only an ACTIVE candidate can move stage, and a hired one cannot be rejected or withdrawn. Any id outside the credential’s tenant — the candidate or the stage — is a 404, never a 403. Requires scope `recruitment:write`. Idempotent via Idempotency-Key.", "security": [ { "apiKey": [] }, { "oauth2": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Dedup key — a retry with the same key replays the first response." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "actor_employee_id" ], "properties": { "actor_employee_id": { "type": "string", "format": "uuid", "description": "The employee this write acts as. Must be an HR admin in the credential’s tenant." }, "stage_id": { "type": "string", "format": "uuid", "description": "A pipeline stage in the credential’s tenant." }, "status": { "type": "string", "enum": [ "active", "rejected", "withdrawn" ], "description": "`active` reactivates a rejected/withdrawn candidate." }, "rejection_reason": { "type": "string", "maxLength": 500, "description": "Required when status is `rejected`." } } } } } }, "responses": { "200": { "description": "Candidate updated", "headers": { "X-Request-Id": { "schema": { "type": "string" } }, "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "401": { "description": "Credential required or invalid", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "403": { "description": "Insufficient scope", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "404": { "description": "Not found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict / idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "422": { "description": "Business rule failed", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "X-Request-Id": { "schema": { "type": "string" } } } } } } } } }