{ "openapi": "3.1.0", "info": { "title": "Ovee Integration API", "version": "2026.11.02", "description": "Supported Ovee integration operations. Send an organisation API access key as Authorization: Bearer `YOUR_API_KEY`. Existing user, role, and organisation permissions apply. See the API Keys and Webhooks guides for setup." }, "servers": [ { "url": "https://app.ovee.com.au", "description": "Ovee application" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Partner onboarding" }, { "name": "Discovery" }, { "name": "Partner compliance" }, { "name": "Partner evidence" }, { "name": "Webhooks" }, { "name": "Partners" }, { "name": "Pools" }, { "name": "People" }, { "name": "Jobs" } ], "paths": { "/api/org/{orgId}/partners/lookup": { "get": { "operationId": "get_api_org_by_orgId_partners_lookup", "summary": "Look up a partner by ABN", "description": "Normalises and validates the ABN. Prefers existing relationships; only minimal identity is returned for unlinked registered organisations. Ambiguity returns 409. Other customers’ manual partners are not disclosed.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "abn", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lookup" } } } } } } }, "/api/org/{orgId}/partners/onboarding": { "post": { "operationId": "post_api_org_by_orgId_partners_onboarding", "summary": "Start or resume partner onboarding", "description": "200 reuses an existing relationship without overwriting data; 201 creates a manual partner; 202 creates or reuses a pending registered-organisation invitation. The target organisation administrator must accept before evidence can be shared. Repeated requests do not resend invitations. No people sharing is enabled.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManualPartnerOrgRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } } }, "201": { "description": "Manual partner created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } } }, "202": { "description": "Registered organisation invitation pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/api/org/{orgId}/partners/onboarding-requests/{requestId}": { "get": { "operationId": "get_api_org_by_orgId_partners_onboarding_requests_by_requestId", "summary": "Read an onboarding request", "description": "Visible only to the requesting or target organisation administrator. Pending invitations expire after 14 days.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestView" } } } } } } }, "/api/org/{orgId}/partners/onboarding-requests/{requestId}/accept": { "post": { "operationId": "post_api_org_by_orgId_partners_onboarding_requests_by_requestId_accept", "summary": "Accept an onboarding invitation", "description": "Requires the invited target organisation’s administrator. Creates the relationship and assigned profiles transactionally. Terminal decisions are idempotent.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestView" } } } } } } }, "/api/org/{orgId}/partners/onboarding-requests/{requestId}/decline": { "post": { "operationId": "post_api_org_by_orgId_partners_onboarding_requests_by_requestId_decline", "summary": "Decline an onboarding invitation", "description": "Requires the invited target organisation’s administrator. Does not create a relationship.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestView" } } } } } } }, "/api/data/domains": { "get": { "operationId": "get_api_data_domains", "summary": "List organisation domains", "description": "Select a domainId supported by your organisation.", "tags": [ "Discovery" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "all", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "globalOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeBase", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDTO" } } } } } } } }, "/api/org/organisation-services": { "get": { "operationId": "get_api_org_organisation_services", "summary": "Discover organisation services", "description": "Lists services for the current organisation’s domain. Use stable service IDs.", "tags": [ "Discovery" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/org-compliance/assignable-profiles": { "get": { "operationId": "get_api_org_compliance_assignable_profiles", "summary": "List assignable compliance profiles", "description": "Lists profiles owned by your organisation with ASSIGNED applicability. Select stable profile IDs based on services and staffing.", "tags": [ "Discovery" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComplianceProfileDTO" } } } } } } } }, "/api/org-compliance/known-requirements": { "get": { "operationId": "get_api_org_compliance_known_requirements", "summary": "List known compliance requirements", "description": "Use stable IDs and keys to map configured requirements; display titles are not identifiers.", "tags": [ "Discovery" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnownComplianceRequirementDTO" } } } } } } } }, "/api/org-compliance/profiles": { "get": { "operationId": "get_api_org_compliance_profiles", "summary": "List your compliance profiles", "description": "Organisation administrators can inspect requirements and partnershipScoped settings. Configure profiles in Ovee before onboarding.", "tags": [ "Discovery" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComplianceProfileDTO" } } } } } } } }, "/api/org/{orgId}/partners/{partnershipId}/takeover-invitation": { "post": { "operationId": "post_api_org_by_orgId_partners_by_partnershipId_takeover_invitation", "summary": "Invite a manual partner to take over", "description": "Preserves the existing partner-token workflow for customer-managed manual partners. This is separate from registered-organisation onboarding acceptance.", "tags": [ "Partner onboarding" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/org-compliance/org/{orgId}/requests/{partnershipId}": { "get": { "operationId": "get_api_org_compliance_org_by_orgId_requests_by_partnershipId", "summary": "Read a compliance request", "description": "Read current applicable steps, request status and completion. orgId is the subject partner organisation, not the API-key organisation.", "tags": [ "Partner compliance" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/requests/{partnershipId}/submit": { "post": { "operationId": "post_api_org_compliance_org_by_orgId_requests_by_partnershipId_submit", "summary": "Submit compliance for review", "description": "Requires evidence-provider permissions. Submission is not approval or completion.", "tags": [ "Partner compliance" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/requests/{partnershipId}/decision": { "post": { "operationId": "post_api_org_compliance_org_by_orgId_requests_by_partnershipId_decision", "summary": "Record a compliance decision", "description": "Requires customer reviewer permissions. Conditional approval does not count as integration completion.", "tags": [ "Partner compliance" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceRequestDecision" } } }, "required": true }, "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/steps/{stepKey}/verification": { "put": { "operationId": "put_api_org_compliance_org_by_orgId_steps_by_stepKey_verification", "summary": "Verify a compliance step", "description": "Supply partnershipId for relationship-scoped evidence. Requires reviewer permissions. A changed response invalidates its previous verification.", "tags": [ "Partner compliance" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceStepVerificationDTO" } } }, "required": true }, "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/steps/{stepKey}/text-evidence": { "put": { "operationId": "put_api_org_compliance_org_by_orgId_steps_by_stepKey_text_evidence", "summary": "Provide text evidence", "description": "Supply partnershipId. Evidence specific to a relationship remains isolated from other customers.", "tags": [ "Partner compliance" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceNoteRequest" } } }, "required": true }, "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/partnerships/{partnershipId}/steps/{stepKey}/bank-account-proposal": { "put": { "operationId": "put_api_org_compliance_org_by_orgId_partnerships_by_partnershipId_steps_by_stepKey_bank_account_proposal", "summary": "Propose relationship bank details", "description": "Stores proposed bank evidence for this partnership, pending review. Does not overwrite the registered organisation’s shared bank record.", "tags": [ "Partner evidence" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountDetailsDTO" } } }, "required": true }, "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/partnerships/{partnershipId}/steps/{stepKey}/attachments/upload": { "post": { "operationId": "post_api_org_compliance_org_by_orgId_partnerships_by_partnershipId_steps_by_stepKey_attachments_upload", "summary": "Begin a private evidence upload", "description": "Returns an attachmentId and short-lived uploadUrl. PUT the bytes to storage without an Ovee API key, then call complete. The step must accept attachments.", "tags": [ "Partner evidence" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upload" } } } } } } }, "/api/org-compliance/org/{orgId}/partnerships/{partnershipId}/attachments/{attachmentId}/complete": { "post": { "operationId": "post_api_org_compliance_org_by_orgId_partnerships_by_partnershipId_attachments_by_attachmentId_complete", "summary": "Associate uploaded evidence", "description": "Checks the stored object and associates it with its server-bound partnership, subject and requirement. Repeated completion is idempotent. Evidence still requires review.", "tags": [ "Partner evidence" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/org-compliance/org/{orgId}/partnerships/{partnershipId}/attachments/{attachmentId}/download-url": { "get": { "operationId": "get_api_org_compliance_org_by_orgId_partnerships_by_partnershipId_attachments_by_attachmentId_download_url", "summary": "Get an authorised download URL", "description": "Returns url, expiresAt, fileName and mimeType after checking visibility in the current compliance summary. URL lifetime is 15 minutes. Response is non-cacheable. Never forward your Ovee API key to storage.", "tags": [ "Partner evidence" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Download" } } }, "headers": { "Cache-Control": { "description": "no-store", "schema": { "type": "string", "const": "no-store" } } } } } } }, "/api/org-compliance/org/{orgId}/partnerships/{partnershipId}/attachments/{attachmentId}": { "delete": { "operationId": "delete_api_org_compliance_org_by_orgId_partnerships_by_partnershipId_attachments_by_attachmentId", "summary": "Remove relationship evidence", "description": "Removes only an authorised attachment from this partnership and subject. Existing signed URLs can remain usable until expiry.", "tags": [ "Partner evidence" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/webhooks/capabilities": { "get": { "operationId": "get_api_webhooks_capabilities", "summary": "Check webhook availability", "description": "Check whether webhook delivery is enabled and signing is configured. Requires an organisation administrator API key.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Capabilities" }, "example": { "enabled": true, "signingConfigured": true } } } } } } }, "/api/webhooks/event-types": { "get": { "operationId": "get_api_webhooks_event_types", "summary": "List supported event types", "description": "Returns event names, descriptions, and related resource API templates.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventType" } } } } } } } }, "/api/webhooks/subscriptions": { "get": { "operationId": "get_api_webhooks_subscriptions", "summary": "List subscriptions", "description": "Lists subscriptions for the organisation bound to the API key. Signing secrets are never returned.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionView" } } } } } } }, "post": { "operationId": "post_api_webhooks_subscriptions", "summary": "Create a subscription", "description": "Creates a subscription for a public HTTPS receiver. Copy signingSecret from this response: it is only returned once. The signing secret is different from your API access key.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInput" }, "example": { "name": "Business integration", "url": "https://integration.example.com/ovee-events", "eventTypes": [ "pool.created", "job.state_changed" ], "enabled": true } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResult" } } } } } } }, "/api/webhooks/subscriptions/{id}": { "get": { "operationId": "get_api_webhooks_subscriptions_by_id", "summary": "Get a subscription", "description": "Returns a subscription belonging to your organisation. A subscription in another organisation returns 404.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionView" } } } } } }, "patch": { "operationId": "patch_api_webhooks_subscriptions_by_id", "summary": "Update or pause a subscription", "description": "Omitted fields are preserved. Supplied eventTypes and associationTypes arrays replace the previous arrays. Set enabled to false to pause, or true to resume and reset the failure counter.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInput" }, "example": { "enabled": false } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionView" } } } } } }, "delete": { "operationId": "delete_api_webhooks_subscriptions_by_id", "summary": "Delete a subscription", "description": "Unsubscribes and cancels queued deliveries. Retains delivery history for the retention period. An in-flight request may finish.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/api/webhooks/subscriptions/{id}/rotate-secret": { "post": { "operationId": "post_api_webhooks_subscriptions_by_id_rotate_secret", "summary": "Rotate the signing secret", "description": "Returns a new signing secret once. The previous secret remains valid for 24 hours; receivers must accept either v1 signature during the overlap.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResult" } } } } } } }, "/api/webhooks/subscriptions/{id}/test": { "post": { "operationId": "post_api_webhooks_subscriptions_by_id_test", "summary": "Send a test notification", "description": "Queues one signed test attempt, including for paused subscriptions. Does not affect automatic-pause counters. Use real events to test retries.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryView" } } } } } } }, "/api/webhooks/subscriptions/{id}/deliveries": { "get": { "operationId": "get_api_webhooks_subscriptions_by_id_deliveries", "summary": "List delivery history", "description": "Cursor-paginated delivery history. Use nextCursor as before on the next request. The default limit is 50; the maximum is 100.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryPage" } } } } } } }, "/api/webhooks/subscriptions/{id}/deliveries/{deliveryId}": { "get": { "operationId": "get_api_webhooks_subscriptions_by_id_deliveries_by_deliveryId", "summary": "Inspect a delivery", "description": "Returns the notification payload and attempt history. Only deliveries belonging to your organisation are accessible.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryDetail" } } } } } } }, "/api/webhooks/subscriptions/{id}/deliveries/{deliveryId}/replay": { "post": { "operationId": "post_api_webhooks_subscriptions_by_id_deliveries_by_deliveryId_replay", "summary": "Replay a failed delivery", "description": "Queues a failed delivery again with the same event ID and a new delivery ID. Account for your receiver deduplication policy.", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryView" } } } } } } }, "/api/org/{orgId}/partners/{partnerOrgId}/preview": { "get": { "operationId": "get_api_org_by_orgId_partners_by_partnerOrgId_preview", "summary": "Get a partner preview", "description": "Retrieves the current partner preview subject to your existing organisation and partnership permissions.", "tags": [ "Partners" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnerOrgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerOrgPreviewDTO" } } } } } } }, "/api/org-compliance/org/{orgId}": { "get": { "operationId": "get_api_org_compliance_org_by_orgId", "summary": "Get partner compliance", "description": "Retrieves current compliance information for the partner organisation identified by orgId. Supply the partnershipId from the event link. Existing relationship permissions and redaction rules apply.", "tags": [ "Partners" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "partnershipId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current partner compliance summary, with permission-dependent redaction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" } } } } } } }, "/api/pool/{id}": { "get": { "operationId": "get_api_pool_by_id", "summary": "Get a pool", "description": "Retrieves the current pool visible to the API key user. Webhook events cover organisation-owned pools; access rules still apply.", "tags": [ "Pools" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "roleTypeId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoolDTO" } } } } } } }, "/api/org/person/{id}": { "get": { "operationId": "get_api_org_person_by_id", "summary": "Get an associated person", "description": "Retrieves person information visible to your organisation. Webhooks do not grant additional access to profile information.", "tags": [ "People" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgPersonDTO" } } } } } } }, "/api/org/person/{id}/onboarding-records": { "get": { "operationId": "get_api_org_person_by_id_onboarding_records", "summary": "Get onboarding records", "description": "Retrieves onboarding records subject to the current user and organisation permissions.", "tags": [ "People" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/job/{id}": { "get": { "operationId": "get_api_job_by_id", "summary": "Get a job", "description": "Retrieves the current job visible to the API key user. A deleted resource may return 404 after its deletion event.", "tags": [ "Jobs" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDTO" } } } } } } }, "/api/job/{jobId}/candidates": { "get": { "operationId": "get_api_job_by_jobId_candidates", "summary": "List job candidates", "description": "Retrieves candidates visible to your organisation. Supports page, size, and sort query parameters; pagination links and totals are returned in response headers.", "tags": [ "Jobs" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page number.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "size", "in": "query", "description": "Number of candidates per page.", "schema": { "type": "integer", "minimum": 1, "default": 20 } }, { "name": "sort", "in": "query", "description": "Property and direction, for example id,asc. Repeat to sort by multiple properties.", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobCandidateWithPersonDTO" } } } }, "headers": { "X-Total-Count": { "description": "Total matching candidates.", "schema": { "type": "integer" } }, "Link": { "description": "Pagination links.", "schema": { "type": "string" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Create an API access key in Organisation Settings → APIs." } }, "schemas": { "Lookup": { "type": "object", "properties": { "abn": { "type": "string" }, "state": { "type": "string" }, "partnerOrgId": { "type": "string" }, "partnershipId": { "type": "string" }, "organisationName": { "type": "string" }, "legalEntityName": { "type": "string" }, "onboardingRequestId": { "type": "string" } } }, "CreateManualPartnerOrgRequestDTO": { "type": "object", "properties": { "name": { "type": "string" }, "domainId": { "type": "string" }, "abn": { "type": "string" }, "gstRegistered": { "type": "boolean" }, "abnName": { "type": "string" }, "abnStatus": { "type": "string" }, "abnType": { "type": "string" }, "abnStateCode": { "type": "string" }, "abnPostCode": { "type": "string" }, "abnTypeCode": { "type": "string" }, "asicNumber": { "type": "string" }, "abnVerified": { "type": "boolean" }, "assignedComplianceProfileIds": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "associationTypes": { "type": "array", "items": { "type": "string" } }, "logo": { "type": "string" }, "overview": { "type": "string" }, "tagsArray": { "type": "array", "items": { "type": "string" } }, "organisationServiceIds": { "type": "array", "items": { "type": "string" } }, "sharePeopleWithPartner": { "type": "boolean" }, "partnerSharesPeopleWithYou": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/AddressDTO" }, "additionalLocations": { "type": "array", "items": { "$ref": "#/components/schemas/OrgLocationDTO" } }, "contactPoints": { "type": "array", "items": { "$ref": "#/components/schemas/ManualPartnerOrgContactDTO" } } } }, "AddressDTO": { "type": "object", "properties": { "id": { "type": "string" }, "postCode": { "type": "string" }, "city": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "formatted": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" } } }, "OrgLocationDTO": { "type": "object", "properties": { "orgId": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "formattedAddress": { "type": "string" }, "locationDescription": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "Address": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postCode": { "type": "string" }, "type": { "type": "string" }, "formatted": { "type": "string" }, "location": { "$ref": "#/components/schemas/GeoPoint" }, "viewPortNorthEast": { "$ref": "#/components/schemas/GeoPoint" }, "viewPortSouthWest": { "$ref": "#/components/schemas/GeoPoint" } } }, "GeoPoint": { "type": "object", "properties": { "type": { "type": "string" }, "coordinates": { "type": "array", "items": { "type": "number", "format": "double" } }, "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" } } }, "ManualPartnerOrgContactDTO": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, "Result": { "type": "object", "properties": { "state": { "type": "string" }, "partnerOrgId": { "type": "string" }, "partnershipId": { "type": "string" }, "onboardingRequestId": { "type": "string" }, "created": { "type": "boolean" } } }, "RequestView": { "type": "object", "properties": { "id": { "type": "string" }, "requestingOrgId": { "type": "string" }, "targetOrgId": { "type": "string" }, "abn": { "type": "string" }, "status": { "type": "string" }, "partnershipId": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "requestingOrgName": { "type": "string" }, "targetOrgName": { "type": "string" }, "complianceProfiles": { "type": "array", "items": { "type": "string" } } } }, "DomainDTO": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "hidden": { "type": "boolean" }, "description": { "type": "string" } } }, "OrganisationComplianceProfileDTO": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "title": { "type": "string" }, "applicability": { "type": "string" }, "description": { "type": "string" }, "associationType": { "type": "string" }, "organisationServiceId": { "type": "string" }, "organisationServiceName": { "type": "string" }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceRequirementDTO" } } } }, "ComplianceRequirementDTO": { "type": "object", "properties": { "responseType": { "type": "string" }, "automaticCheck": { "type": "string" }, "knownRequirementId": { "type": "string" }, "knownRequirementArchived": { "type": "boolean" }, "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "textRequired": { "type": "boolean" }, "attachmentRequired": { "type": "boolean" }, "partnershipScoped": { "type": "boolean" } } }, "KnownComplianceRequirementDTO": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "attachmentRequired": { "type": "boolean" }, "textRequired": { "type": "boolean" }, "archived": { "type": "boolean" }, "version": { "type": "integer", "format": "int64" }, "automaticCheck": { "type": "string" }, "builtIn": { "type": "boolean" }, "responseType": { "type": "string" } } }, "InvitationRequest": { "type": "object", "properties": { "email": { "type": "string" }, "token": { "type": "string" } } }, "OrganisationComplianceSummaryDTO": { "type": "object", "properties": { "completion": { "$ref": "#/components/schemas/Completion" }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComplianceProfileSummaryDTO" } }, "orgId": { "type": "string" }, "orgName": { "type": "string" }, "partnershipId": { "type": "string" }, "complianceRequestStatus": { "type": "string" }, "complianceRequestReason": { "type": "string" }, "status": { "type": "string" }, "statusLabel": { "type": "string" }, "completedSteps": { "type": "integer", "format": "int32" }, "totalSteps": { "type": "integer", "format": "int32" }, "progressPercent": { "type": "integer", "format": "int32" }, "expiringSoonCount": { "type": "integer", "format": "int32" }, "expiredCount": { "type": "integer", "format": "int32" }, "needsVerificationCount": { "type": "integer", "format": "int32" }, "incompleteCount": { "type": "integer", "format": "int32" }, "conditionalCount": { "type": "integer", "format": "int32" }, "notCompliantCount": { "type": "integer", "format": "int32" }, "lastUpdatedAt": { "type": "string", "format": "date-time" }, "lastUpdatedByName": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComplianceStepDetailDTO" } } } }, "Completion": { "type": "object", "properties": { "completed": { "type": "boolean" }, "lastCompletedAt": { "type": "string", "format": "date-time" }, "approvalUrl": { "type": "string" } } }, "OrganisationComplianceProfileSummaryDTO": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "applicability": { "type": "string" }, "associationType": { "type": "string" }, "organisationServiceId": { "type": "string" }, "status": { "type": "string" }, "statusLabel": { "type": "string" }, "completedSteps": { "type": "integer", "format": "int32" }, "totalSteps": { "type": "integer", "format": "int32" }, "progressPercent": { "type": "integer", "format": "int32" }, "requirementKeys": { "type": "array", "items": { "type": "string" } } } }, "OrganisationComplianceStepDetailDTO": { "type": "object", "properties": { "partnershipScoped": { "type": "boolean" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentView" } }, "bankAccountDetails": { "$ref": "#/components/schemas/BankAccountDetailsDTO" }, "responseType": { "type": "string" }, "evidenceStepKeys": { "type": "array", "items": { "type": "string" } }, "automaticCheck": { "type": "string" }, "stepKey": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "textRequired": { "type": "boolean" }, "attachmentRequired": { "type": "boolean" }, "evidenceText": { "type": "string" }, "evidenceTextProvidedByName": { "type": "string" }, "evidenceTextProvidedByOrganisationName": { "type": "string" }, "attachmentCount": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "statusLabel": { "type": "string" }, "verification": { "$ref": "#/components/schemas/OrganisationComplianceStepVerificationDTO" } } }, "AttachmentView": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "mimeType": { "type": "string" } } }, "BankAccountDetailsDTO": { "type": "object", "properties": { "accountName": { "type": "string" }, "bsb": { "type": "string" }, "accountNumber": { "type": "string" } } }, "OrganisationComplianceStepVerificationDTO": { "type": "object", "properties": { "verified": { "type": "boolean" }, "conditional": { "type": "boolean" }, "conditionalReason": { "type": "string" }, "rejected": { "type": "boolean" }, "rejectionReason": { "type": "string" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verifiedByUserId": { "type": "string" }, "verifiedByName": { "type": "string" }, "verificationMethod": { "type": "string" }, "verificationServiceName": { "type": "string" }, "verificationNote": { "type": "string" }, "dateReceived": { "type": "string", "format": "date" }, "dateExpires": { "type": "string", "format": "date" }, "automaticCheck": { "type": "string" }, "checkedAbn": { "type": "string" }, "checkedAt": { "type": "string", "format": "date-time" }, "checkOutcome": { "type": "string" }, "automaticComplianceOverridden": { "type": "boolean" }, "automaticComplianceOverrideReason": { "type": "string" }, "automaticComplianceOverrideByName": { "type": "string" }, "automaticComplianceOverrideAt": { "type": "string", "format": "date-time" }, "registerStatus": { "type": "string" }, "registeredEntityName": { "type": "string" }, "registerUrl": { "type": "string" }, "sourceId": { "type": "string" }, "sourceRunId": { "type": "string" }, "sourceUpdatedAt": { "type": "string", "format": "date-time" }, "sourceCompiledDate": { "type": "string" }, "knownOrganisationId": { "type": "string" }, "checkResults": { "type": "array", "items": { "$ref": "#/components/schemas/AutomatedComplianceCheckResult" } } } }, "AutomatedComplianceCheckResult": { "type": "object", "properties": { "criterion": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string" }, "detail": { "type": "string" } } }, "ComplianceRequestDecision": { "type": "object", "properties": { "action": { "type": "string" }, "reason": { "type": "string" } } }, "ComplianceNoteRequest": { "type": "object", "properties": { "text": { "type": "string" } } }, "UploadInput": { "type": "object", "properties": { "fileName": { "type": "string" }, "mimeType": { "type": "string" } } }, "Upload": { "type": "object", "properties": { "attachmentId": { "type": "string" }, "uploadUrl": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "Download": { "type": "object", "properties": { "url": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "fileName": { "type": "string" }, "mimeType": { "type": "string" } } }, "Capabilities": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "signingConfigured": { "type": "boolean" } } }, "EventType": { "type": "object", "properties": { "type": { "type": "string" }, "group": { "type": "string" }, "description": { "type": "string" }, "apiTemplate": { "type": "string" } } }, "SubscriptionView": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "associationTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "enabled": { "type": "boolean" }, "pausedReason": { "type": "string" }, "consecutiveExhausted": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastSuccessAt": { "type": "string", "format": "date-time" } } }, "SubscriptionInput": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "associationTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "enabled": { "type": "boolean" } } }, "SecretResult": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionView" }, "signingSecret": { "type": "string" } } }, "DeliveryView": { "type": "object", "properties": { "id": { "type": "string" }, "subscriptionId": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string" }, "test": { "type": "boolean" }, "attemptCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "nextAttemptAt": { "type": "string", "format": "date-time" }, "replayedAs": { "type": "string" }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/Attempt" } } } }, "Attempt": { "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "statusCode": { "type": "integer", "format": "int32" }, "error": { "type": "string" }, "durationMs": { "type": "integer", "format": "int64" } } }, "DeliveryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryView" } }, "nextCursor": { "type": "string" } } }, "DeliveryDetail": { "type": "object", "properties": { "delivery": { "$ref": "#/components/schemas/DeliveryView" }, "event": {} } }, "PartnerOrgPreviewDTO": { "type": "object", "properties": { "contactPoints": { "type": "array", "items": { "$ref": "#/components/schemas/OrgContactPoint" } }, "address": { "$ref": "#/components/schemas/AddressDTO" }, "remittanceEmail": { "type": "string" }, "compliance": { "$ref": "#/components/schemas/OrganisationComplianceSummaryDTO" }, "orgId": { "type": "string" }, "partnershipId": { "type": "string" }, "name": { "type": "string" }, "associationType": { "type": "string" }, "logo": { "type": "string" }, "overview": { "type": "string" }, "website": { "type": "string" }, "abn": { "type": "string" }, "gstRegistered": { "type": "boolean" }, "abnName": { "type": "string" }, "manualPartnerOrg": { "type": "boolean" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "domainNames": { "type": "array", "items": { "type": "string" } }, "organisationServiceNames": { "type": "array", "items": { "type": "string" } }, "partnerServiceNames": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerOrgLocationDTO" } }, "sharedPeople": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerOrgPreviewPersonDTO" } }, "onboardedPeople": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerOrgPreviewPersonDTO" } }, "documentCount": { "type": "integer", "format": "int64" }, "legalEntityName": { "type": "string" }, "tradingName": { "type": "string" } } }, "OrgContactPoint": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, "PartnerOrgLocationDTO": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" } } }, "PartnerOrgPreviewPersonDTO": { "type": "object", "properties": { "personId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "image": { "type": "string" }, "location": { "type": "string" }, "headline": { "type": "string" }, "associationLabel": { "type": "string" }, "relationshipTypeLabel": { "type": "string" } } }, "PoolDTO": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "orgId": { "type": "string" }, "entityType": { "type": "string" }, "communityInvitationEnabled": { "type": "boolean" }, "communityInvitationScope": { "type": "string" }, "ownerId": { "type": "string" }, "ownerType": { "type": "string" }, "description": { "type": "string" }, "colour": { "type": "string" }, "image": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "favourite": { "type": "boolean" }, "favouriteUserIds": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "aiCandidateInsights": { "$ref": "#/components/schemas/AIPoolCandidateInsightsDTO" }, "aiCandidateInsightsByRoleType": { "type": "array", "items": { "$ref": "#/components/schemas/PoolRoleTypeAIInsightsDTO" } }, "aiInsightsRunStatus": { "$ref": "#/components/schemas/PoolAIInsightsRunStatusDTO" }, "domainId": { "type": "string" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "candidateFlowId": { "type": "string" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeInstanceDTO" } }, "strictRoleTypes": { "type": "boolean" }, "roleTypeSelectionMode": { "type": "string", "enum": [ "APPLIED_FOR_ROLE_TYPE_ONLY", "ACTIVE_ROLE_TYPES", "ALL_ROLE_TYPES" ] }, "usePrimaryRoleTypesOnly": { "type": "boolean" }, "complianceProfileIds": { "type": "array", "items": { "type": "string" } }, "complianceProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceProfileDTO" } }, "selectedRoleTypeViewId": { "type": "string" }, "selectedRoleTypeViewName": { "type": "string" }, "linkedWorkstreams": { "type": "array", "items": { "$ref": "#/components/schemas/PoolLinkedWorkstreamDTO" } }, "showUtilisationTab": { "type": "boolean" }, "automaticAiInsightsRefreshEnabled": { "type": "boolean" }, "memberCount": { "type": "integer", "format": "int32" }, "unreadPosts": { "type": "boolean" }, "unreadDirectMessages": { "type": "boolean" }, "sharedPool": { "type": "boolean" }, "sharedPoolRole": { "type": "string" }, "sharedSourcePoolId": { "type": "string" }, "sharedSourceOrgId": { "type": "string" }, "sharedSourceOrgName": { "type": "string" }, "sharedShareCount": { "type": "integer", "format": "int32" }, "sharedTargetOrgIds": { "type": "array", "items": { "type": "string" } }, "sharedTargetOrgNames": { "type": "array", "items": { "type": "string" } }, "poolPeople": { "type": "array", "items": { "$ref": "#/components/schemas/PoolPersonDTO" } }, "candidateStages": { "$ref": "#/components/schemas/CandidateStagesDTO" }, "peopleCriteria": { "$ref": "#/components/schemas/CandidateSearchCriteraDTO" } } }, "AIPoolCandidateInsightsDTO": { "type": "object", "properties": { "poolId": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "candidatesSentToAI": { "type": "integer", "format": "int32" }, "summary": { "type": "string" }, "noStrongMatch": { "type": "boolean" }, "noStrongMatchReason": { "type": "string" }, "topCandidates": { "type": "array", "items": { "$ref": "#/components/schemas/TopCandidate" } }, "candidateInsights": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateInsight" } }, "aiCandidateStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateStatus" } } } }, "TopCandidate": { "type": "object", "properties": { "candidateId": { "type": "string" }, "candidateName": { "type": "string" }, "aiCandidateRank": { "type": "integer", "format": "int32" }, "aiSuitabilityScore": { "type": "integer", "format": "int32" }, "aiSuitabilityJustification": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } } } }, "CandidateInsight": { "type": "object", "properties": { "candidateId": { "type": "string" }, "candidateName": { "type": "string" }, "aiCandidateRank": { "type": "integer", "format": "int32" }, "aiSuitabilityScore": { "type": "integer", "format": "int32" }, "aiSuitabilityJustification": { "type": "string" }, "highlights": { "type": "array", "items": { "type": "string" } } } }, "CandidateStatus": { "type": "object", "properties": { "candidateId": { "type": "string" }, "candidateName": { "type": "string" }, "includedInAiRun": { "type": "boolean" }, "returnedByAi": { "type": "boolean" }, "aiAvailabilityReason": { "type": "string" } } }, "PoolRoleTypeAIInsightsDTO": { "type": "object", "properties": { "roleTypeId": { "type": "string" }, "roleTypeName": { "type": "string" }, "aiCandidateInsights": { "$ref": "#/components/schemas/AIPoolCandidateInsightsDTO" } } }, "PoolAIInsightsRunStatusDTO": { "type": "object", "properties": { "runId": { "type": "string" }, "status": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string" }, "roleTypeId": { "type": "string" }, "includeOverallInsights": { "type": "boolean" }, "candidateCount": { "type": "integer", "format": "int32" } } }, "RoleTypeInstanceDTO": { "type": "object", "properties": { "roleTypeId": { "type": "string" }, "roleType": { "type": "string" }, "proficiency": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" } } }, "ComplianceProfileDTO": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "domainId": { "type": "string" }, "orgId": { "type": "string" }, "associationType": { "type": "string" }, "associationTypes": { "type": "array", "items": { "type": "string" } }, "onboarding": { "type": "boolean" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeInstance" } }, "requiredPersonFields": { "type": "object", "additionalProperties": { "type": "boolean" } }, "qualificationList": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "onboardingQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceProfileQuestion" } } } }, "RoleTypeInstance": { "type": "object", "properties": { "roleTypeId": { "$ref": "#/components/schemas/ObjectId" }, "roleType": { "type": "string" }, "proficiency": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" } }, "required": [ "roleType", "roleTypeId" ] }, "ObjectId": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" } } }, "QualificationInstance": { "type": "object", "properties": { "id": { "type": "string" }, "qualificationId": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "dateStarted": { "type": "string", "format": "date" }, "dateReceived": { "type": "string", "format": "date" }, "dateExpires": { "type": "string", "format": "date" }, "sourceId": { "type": "string" }, "authority": { "type": "string" }, "location": { "type": "string" }, "extraInformation": { "type": "string" }, "authorityReferenceIdName": { "type": "string" }, "authorityReferenceId": { "type": "string" }, "verifiedBy": { "$ref": "#/components/schemas/ObjectId" }, "verified": { "type": "boolean" }, "verifiedDateTime": { "type": "string", "format": "date-time" }, "verifiedByName": { "type": "string" }, "verificationMethod": { "type": "string" }, "verificationRequired": { "type": "boolean" }, "docNeeded": { "type": "string" }, "documentName": { "type": "string" }, "documentAttachmentId": { "type": "string" }, "documentAck": { "type": "boolean" }, "attachmentIds": { "type": "array", "items": { "type": "string" } }, "minExperienceYears": { "type": "number", "format": "double" } }, "required": [ "qualificationId", "title" ] }, "ComplianceProfileQuestion": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "responderType": { "type": "string" }, "valueType": { "type": "string", "enum": [ "BOOLEAN", "TEXT" ] }, "displayOrder": { "type": "integer", "format": "int32" } } }, "PoolLinkedWorkstreamDTO": { "type": "object", "properties": { "workstreamId": { "type": "string" }, "workstreamTitle": { "type": "string" }, "resourcePlanId": { "type": "string" }, "resourceId": { "type": "string" }, "roleName": { "type": "string" } } }, "PoolPersonDTO": { "type": "object", "properties": { "id": { "type": "string" }, "poolId": { "type": "string" }, "personId": { "type": "string" }, "person": { "$ref": "#/components/schemas/PoolPersonDetailsDTO" }, "notes": { "type": "integer", "format": "int32" }, "personStatus": { "type": "string" }, "aiInsights": { "type": "array", "items": { "type": "string" } }, "aiCandidateRank": { "type": "integer", "format": "int32" }, "orgUserNotes": { "type": "array", "items": { "type": "string" } }, "complianceAssessment": { "$ref": "#/components/schemas/PoolPersonComplianceDTO" }, "poolTag": { "type": "string" }, "poolTags": { "type": "array", "items": { "$ref": "#/components/schemas/PoolPersonTagItemDTO" } }, "appliedForRoleType": { "$ref": "#/components/schemas/RoleTypeInstanceDTO" }, "score": { "type": "number", "format": "double" }, "addedDate": { "type": "string", "format": "date-time" }, "profileUpdatedDate": { "type": "string", "format": "date-time" }, "aiInsightsRefreshing": { "type": "boolean" }, "missingSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "missingDesirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingDesirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } } } }, "PoolPersonDetailsDTO": { "type": "object", "properties": { "id": { "type": "string" }, "archived": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "preferredFirstName": { "type": "string" }, "headline": { "type": "string" }, "image": { "type": "string" }, "domain": { "type": "string" }, "domainId": { "type": "string" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleType" } }, "location": { "type": "string" }, "stars": { "type": "string" }, "newProfile": { "type": "boolean" }, "declaredAvailability": { "type": "boolean" }, "declaredAvailableFrom": { "type": "string" }, "availabilityStatus": { "type": "string" }, "availabilityFrom": { "type": "string" }, "availabilityUntil": { "type": "string" }, "availabilityCapacity": { "type": "string" }, "availabilityContinuity": { "type": "string" }, "availabilityIncludesTentative": { "type": "boolean" }, "availabilityGenerated": { "type": "boolean" } } }, "RoleType": { "type": "object", "properties": { "id": { "type": "string" }, "domainId": { "type": "string" }, "categoryId": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "roleType": { "type": "string" }, "orgId": { "type": "string" }, "originalId": { "type": "string" }, "defaultRequiredSkills": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "defaultDesirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "defaultRequiredQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "defaultDesirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "aka": { "type": "array", "items": { "type": "string" } }, "associatedStandards": { "type": "array", "items": { "$ref": "#/components/schemas/StandardReference" } }, "createdDate": { "type": "string", "format": "date-time" } }, "required": [ "roleType" ] }, "Skill": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "orgId": { "type": "string" }, "originalId": { "type": "string" }, "source": { "type": "string" }, "sourceCode": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/StandardReference" } }, "aka": { "type": "array", "items": { "type": "string" } }, "staged": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "approved": { "type": "boolean" }, "softSkill": { "type": "boolean" }, "technicalSkill": { "type": "boolean" }, "minExperienceYears": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "mapping": { "type": "array", "items": { "$ref": "#/components/schemas/StandardReference" }, "writeOnly": true } }, "required": [ "title" ] }, "StandardReference": { "type": "object", "properties": { "id": { "type": "string" }, "standardName": { "type": "string" }, "standardVersion": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "minLevel": { "type": "integer", "format": "int32" }, "maxLevel": { "type": "integer", "format": "int32" }, "proficiencyLevel1Equivalent": { "type": "integer", "format": "int32" }, "proficiencyLevel2Equivalent": { "type": "integer", "format": "int32" }, "proficiencyLevel3Equivalent": { "type": "integer", "format": "int32" }, "proficiencyLevel4Equivalent": { "type": "integer", "format": "int32" }, "proficiencyLevel5Equivalent": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "subCategory": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "url": { "type": "string" } } }, "Qualification": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "authority": { "type": "string" }, "authorityId": { "type": "string" }, "knownAuthority": { "type": "string" }, "knownType": { "type": "string" }, "authorityReferenceIdName": { "type": "string" }, "description": { "type": "string" }, "orgId": { "type": "string" }, "approved": { "type": "boolean" }, "domainId": { "type": "string" }, "keyForDomain": { "type": "array", "items": { "$ref": "#/components/schemas/DomainOrg" } }, "aka": { "type": "array", "items": { "type": "string" } }, "minExperienceYears": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "required": [ "title" ] }, "DomainOrg": { "type": "object", "properties": { "domainId": { "type": "string" }, "orgId": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "PoolPersonComplianceDTO": { "type": "object", "properties": { "personId": { "type": "string" }, "status": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PoolPersonComplianceItemDTO" } }, "tooltipItems": { "type": "array", "items": { "type": "string" } } } }, "PoolPersonComplianceItemDTO": { "type": "object", "properties": { "profileId": { "type": "string" }, "profileTitle": { "type": "string" }, "itemKey": { "type": "string" }, "itemLabel": { "type": "string" }, "status": { "type": "string" } } }, "PoolPersonTagItemDTO": { "type": "object", "properties": { "tag": { "type": "string" }, "userId": { "type": "string" }, "userName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } } }, "SkillInstance": { "type": "object", "properties": { "title": { "type": "string" }, "proficiency": { "type": "integer", "format": "int32" }, "primary": { "type": "boolean" }, "minExperienceYears": { "type": "number", "format": "double" }, "skillId": { "type": "string" } }, "required": [ "title" ] }, "CandidateStagesDTO": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "candidateFlowId": { "type": "string" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateStagePositionDTO" } } } }, "CandidateStagePositionDTO": { "type": "object", "properties": { "personId": { "type": "string" }, "stageName": { "type": "string" }, "position": { "type": "integer", "format": "int32" } } }, "CandidateSearchCriteraDTO": { "type": "object", "properties": { "verifiedPeopleOnly": { "type": "boolean" }, "rightToWorkOnly": { "type": "boolean" }, "excludeVisaHolders": { "type": "boolean" }, "excludePermanentResidents": { "type": "boolean" }, "associationTypes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "sharedFromOrgId": { "type": "string" }, "jobType": { "type": "string" }, "employmentTypes": { "type": "array", "items": { "type": "string" } }, "domainIds": { "type": "array", "items": { "type": "string" } }, "desirableCriteriaOptional": { "type": "boolean" }, "roleTypeId": { "type": "string" }, "strictRoleTypeMatch": { "type": "boolean" }, "requiredSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "desirableSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "requiredQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "requiredIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeInstance" } }, "requiredSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "desirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "requiredQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "desirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "requiredIndustries": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "desirableIndustries": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "distributeTo": { "type": "array", "items": { "type": "string" } }, "distributeToPool": { "type": "array", "items": { "type": "string" } }, "includeOverallInsights": { "type": "boolean" }, "roleCriteriaList": { "type": "array", "items": { "$ref": "#/components/schemas/PoolAIRoleCriteriaDTO" } }, "minRoleExperienceYears": { "type": "number", "format": "double" }, "workplaceOptions": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "type": "string" } }, "geoLocations": { "type": "array", "items": { "$ref": "#/components/schemas/LatLng" } }, "checkAvailability": { "type": "boolean" }, "dateTime": { "type": "string", "format": "date-time" }, "dateTimeEnd": { "type": "string", "format": "date-time" }, "earliestDateTime": { "type": "string", "format": "date-time" }, "latestDateTime": { "type": "string", "format": "date-time" }, "fixedTerm": { "type": "string" }, "fixedTermType": { "type": "string" }, "loading": { "type": "number", "format": "double" }, "sex": { "type": "string" } } }, "PoolAIRoleCriteriaDTO": { "type": "object", "properties": { "roleTypeId": { "type": "string" }, "roleTypeName": { "type": "string" }, "criteria": {} } }, "LatLng": { "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" } } }, "OrgPersonDTO": { "type": "object", "properties": { "id": { "type": "string" }, "archived": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "preferredFirstName": { "type": "string" }, "image": { "type": "string" }, "domain": { "type": "string" }, "domainId": { "type": "string" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "stars": { "type": "string" }, "location": { "type": "string" }, "skills": { "type": "string" }, "skillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "reviews": { "type": "string" }, "headline": { "type": "string" }, "overview": { "type": "string" }, "profileVideoUrl": { "type": "string" }, "experienceOverview": { "type": "string" }, "achievements": { "type": "string" }, "external": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDTO" } }, "declaredAvailability": { "type": "boolean" }, "declaredAvailableFrom": { "type": "string" }, "regularWorkingHours": { "$ref": "#/components/schemas/RegularWorkingHours" }, "availabilityStatus": { "type": "string" }, "availabilityFrom": { "type": "string" }, "availabilityUntil": { "type": "string" }, "availabilityCapacity": { "type": "string" }, "availabilityContinuity": { "type": "string" }, "availabilityIncludesTentative": { "type": "boolean" }, "availabilityGenerated": { "type": "boolean" }, "manualAvailableAfter": { "type": "boolean" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeDTO" } }, "sex": { "type": "string" }, "r2w": { "type": "string" }, "r2wVisaExpiryDate": { "type": "string", "format": "date" }, "dob": { "type": "string", "format": "date" }, "citizenship": { "type": "string" }, "orgAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/OrgAssociation" } }, "poolMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/PoolMembershipSummaryDTO" } }, "nearbyAddress": { "$ref": "#/components/schemas/AddressDTO" }, "nearbyFormattedAddress": { "type": "string" }, "email": { "type": "string" }, "telephone": { "type": "string" }, "telegramChatId": { "type": "string" }, "emergencyContactName": { "type": "string" }, "emergencyContactEmail": { "type": "string" }, "emergencyContactPhoneNumber": { "type": "string" }, "qualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "highestDegreeId": { "type": "string" }, "yearsExperience": { "type": "string" }, "compensationExpectation": { "$ref": "#/components/schemas/CompensationExpectation" }, "compensationExpectations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationCompensationExpectation" } }, "employmentTypes": { "type": "array", "items": { "type": "string" } }, "orgIds": { "type": "string" }, "optPublic": { "type": "boolean" }, "blindProfile": { "type": "boolean" }, "tfn": { "type": "string" }, "abn": { "type": "string" }, "bankAccountName": { "type": "string" }, "bsb": { "type": "string" }, "bankAccountNumber": { "type": "string" }, "maxKMFromLocation": { "type": "integer", "format": "int32" }, "remoteWorkConsidered": { "type": "boolean" }, "relocationConsideredOptions": { "type": "array", "items": { "type": "string" } }, "travelConsideredOptions": { "type": "array", "items": { "type": "string" } }, "ownedById": { "type": "string" }, "ownedByOrg": { "type": "string" }, "ownedByName": { "type": "string" }, "userId": { "type": "string" }, "newProfile": { "type": "boolean" }, "oveeVerification": { "$ref": "#/components/schemas/OveeVerification" }, "organisationLocations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationLocationGroup" } }, "extraDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraDetail" } }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "publications": { "type": "array", "items": { "$ref": "#/components/schemas/Publication" } }, "personalInterests": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalInterest" } }, "personInfo": { "$ref": "#/components/schemas/OrgPersonInfoDTO" }, "emailMessagingAvailable": { "type": "boolean" }, "willConsiderRemoteOptions": { "type": "array", "deprecated": true, "items": { "type": "string", "deprecated": true } }, "minHourlyRate": { "type": "string" }, "minYearlySalary": { "type": "string" }, "skillsArray": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" } } }, "LinkDTO": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "image": { "type": "string" } } }, "RegularWorkingHours": { "type": "object", "properties": { "templateId": { "type": "string" }, "maximumHoursPerWeek": { "type": "integer", "format": "int32" }, "days": { "type": "array", "items": { "$ref": "#/components/schemas/RegularWorkingDay" } } } }, "RegularWorkingDay": { "type": "object", "properties": { "dayId": { "type": "string" }, "label": { "type": "string" }, "workingDay": { "type": "boolean" }, "startTime": { "type": "string" }, "endTime": { "type": "string" } } }, "RoleTypeDTO": { "type": "object", "properties": { "id": { "type": "string" }, "roleType": { "type": "string" }, "categoryId": { "type": "string" }, "category": { "type": "string" }, "domainId": { "type": "string" }, "originalId": { "type": "string" }, "source": { "type": "string" }, "description": { "type": "string" }, "defaultRequiredSkills": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "defaultDesirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "defaultRequiredQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "defaultDesirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "aka": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "base": { "type": "boolean" }, "associatedStandards": { "type": "array", "items": { "$ref": "#/components/schemas/StandardReference" } }, "domains": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDTO" } } } }, "OrgAssociation": { "type": "object", "properties": { "orgId": { "type": "string" }, "orgName": { "type": "string" }, "associationType": { "type": "string" }, "profileTemplateId": { "type": "string" }, "logo": { "type": "string" }, "onboarding": { "type": "boolean" }, "onboarded": { "type": "boolean" }, "employed": { "type": "boolean" }, "shared": { "type": "boolean" }, "sharedFromOrgId": { "type": "string" }, "sharedFromOrgName": { "type": "string" }, "relationshipType": { "type": "string" }, "employmentOrEngagementType": { "type": "string" }, "workArrangement": { "type": "string" }, "probationEnds": { "type": "string", "format": "date" }, "organisationEmail": { "type": "string" } } }, "PoolMembershipSummaryDTO": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "CompensationExpectation": { "type": "object", "properties": { "annualSalary": { "$ref": "#/components/schemas/CompensationValue" }, "noAnnualSalaryExpectation": { "type": "boolean" }, "contractRateType": { "type": "string" }, "hourlyRate": { "$ref": "#/components/schemas/CompensationValue" }, "dayRate": { "$ref": "#/components/schemas/CompensationValue" }, "noContractRateExpectation": { "type": "boolean" }, "note": { "type": "string" } } }, "CompensationValue": { "type": "object", "properties": { "minimumExpected": { "type": "string" }, "preferredValue": { "type": "string" }, "includesSuper": { "type": "boolean" } } }, "OrganisationCompensationExpectation": { "type": "object", "properties": { "orgId": { "type": "string" }, "compensationExpectation": { "$ref": "#/components/schemas/CompensationExpectation" } } }, "OveeVerification": { "type": "object", "properties": { "verified": { "type": "boolean" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verifiedByUserId": { "$ref": "#/components/schemas/ObjectId" }, "verifiedByName": { "type": "string" }, "verificationMethod": { "type": "string" }, "verificationNote": { "type": "string" } } }, "OrganisationLocationGroup": { "type": "object", "properties": { "orgId": { "type": "string" }, "orgName": { "type": "string" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationItem" } } } }, "LocationItem": { "type": "object", "properties": { "locationId": { "type": "string" }, "locationName": { "type": "string" } } }, "ExtraDetail": { "type": "object", "properties": { "detailId": { "type": "string" }, "title": { "type": "string" }, "orgId": { "type": "string" }, "valueType": { "type": "string", "enum": [ "BOOLEAN", "TEXT" ] }, "booleanValue": { "type": "boolean" }, "textValue": { "type": "string" } } }, "Association": { "type": "object", "properties": { "associationName": { "type": "string" }, "description": { "type": "string" }, "websiteUrl": { "type": "string" } } }, "Publication": { "type": "object", "properties": { "title": { "type": "string" }, "publicationType": { "type": "string" }, "publisherOrPublicationName": { "type": "string" }, "publicationDate": { "type": "string" }, "authors": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "description": { "type": "string" }, "doiOrReference": { "type": "string" }, "visibility": { "type": "string" } } }, "PersonalInterest": { "type": "object", "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" } } }, "OrgPersonInfoDTO": { "type": "object", "properties": { "id": { "type": "string" }, "endorsed": { "type": "boolean" }, "trusted": { "type": "boolean" }, "employed": { "type": "boolean" }, "linked": { "type": "boolean" }, "pending": { "type": "boolean" }, "shared": { "type": "boolean" }, "sharedFromOrgId": { "type": "string" }, "sharedFromOrgName": { "type": "string" }, "associationRequestPending": { "type": "boolean" }, "associationRequestTargetType": { "type": "string" }, "requestedAssociationType": { "type": "string" }, "associationRequestedAt": { "type": "string", "format": "date-time" }, "associationRequestedByOrgId": { "type": "string" }, "associationRequestedByOrgName": { "type": "string" }, "onboarding": { "type": "boolean" }, "onboarded": { "type": "boolean" }, "offboarding": { "type": "boolean" }, "blacklisted": { "type": "boolean" }, "blacklistReason": { "type": "string" }, "relationshipType": { "type": "string" }, "employmentOrEngagementType": { "type": "string" }, "workArrangement": { "type": "string" }, "probationEnds": { "type": "string", "format": "date" }, "organisationEmail": { "type": "string" }, "partnerOrgId": { "type": "string" }, "partnerOrgName": { "type": "string" }, "onboardingTargetAssociationType": { "type": "string" }, "onboardingTargetJobId": { "type": "string" }, "onboardingTargetJobTitle": { "type": "string" }, "averageScore": { "type": "number", "format": "double" }, "reviews": { "type": "integer", "format": "int32" }, "score": { "type": "number", "format": "double" }, "missingSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "missingDesirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingDesirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } } } }, "JobDTO": { "type": "object", "properties": { "id": { "type": "string" }, "jobKind": { "type": "string" }, "parentJobId": { "type": "string" }, "parentTitle": { "type": "string" }, "sourceJobCandidateId": { "type": "string" }, "vacancyCount": { "type": "integer", "format": "int32" }, "requestStatus": { "type": "string" }, "filledCount": { "type": "integer", "format": "int32" }, "remainingCount": { "type": "integer", "format": "int32" }, "assignments": { "type": "array", "items": {} }, "title": { "type": "string" }, "description": { "type": "string" }, "domainId": { "type": "string" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "ownerId": { "type": "string" }, "stereotype": { "type": "string" }, "external": { "type": "boolean" }, "state": { "type": "string" }, "jobState": { "type": "string" }, "viewed": { "type": "boolean" }, "bookmarked": { "type": "boolean" }, "bookmarkAvailable": { "type": "boolean" }, "posted": { "type": "string", "format": "date-time" }, "dateTime": { "type": "string", "format": "date-time" }, "dateTimeEnd": { "type": "string", "format": "date-time" }, "latestDateTime": { "type": "string", "format": "date-time" }, "lastUpdated": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "employmentTypes": { "type": "array", "items": { "type": "string", "enum": [ "Permanent Full-time", "Permanent Part-time", "Fixed Term", "Casual", "Volunteer", "Intern/Student Placement", "Contract", "Graduate", "Apprenticeship" ] } }, "acceptedRate": { "type": "string" }, "offer": { "type": "string" }, "currency": { "type": "string" }, "tags": { "type": "string" }, "locationOption": { "type": "string" }, "address": { "$ref": "#/components/schemas/AddressDTO" }, "workplaceOption": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/OrgLocationDTO" } }, "org": { "$ref": "#/components/schemas/OrgDTO" }, "assignedTo": { "type": "string" }, "personStatus": { "type": "string" }, "assignedToPerson": { "$ref": "#/components/schemas/PersonDTO" }, "teamId": { "type": "string" }, "teamMembers": { "type": "array", "items": { "$ref": "#/components/schemas/TeamMemberDTO" } }, "completedBy": { "type": "string" }, "completionNotes": { "type": "string" }, "completed": { "type": "string" }, "completedStarsCount": { "type": "string" }, "originalDateTime": { "type": "string" }, "originalDateTimeEnd": { "type": "string" }, "noShowAction": { "type": "string" }, "hoursPerWeek": { "type": "string" }, "payDirect": { "type": "boolean" }, "payCash": { "type": "boolean" }, "selectionMethod": { "type": "string" }, "autoSelectPool": { "type": "string" }, "autoSelectTime": { "type": "string" }, "pricingOption": { "type": "string" }, "rateMin": { "type": "string" }, "rateMax": { "type": "string" }, "sellRate": { "type": "string" }, "payrollTaxRate": { "type": "string" }, "costRate": { "type": "string" }, "superannuationRate": { "type": "string" }, "otherCostsRate": { "type": "string" }, "otherCostsAmount": { "type": "string" }, "distributionOnboarded": { "type": "boolean" }, "distributionShared": { "type": "boolean" }, "distributionEmployees": { "type": "boolean" }, "distributionTrusted": { "type": "boolean" }, "distributionLinked": { "type": "boolean" }, "distributionPublic": { "type": "boolean" }, "distributionDirected": { "type": "boolean" }, "distributionPool": { "type": "boolean" }, "browseEnabled": { "type": "boolean" }, "distributeTo": { "type": "array", "items": { "type": "string" } }, "distributeToArray": { "type": "array", "items": { "$ref": "#/components/schemas/PersonCoreDTO" } }, "distributeToPool": { "type": "array", "items": { "type": "string" } }, "distributeToPoolArray": { "type": "array", "items": { "$ref": "#/components/schemas/Pool" } }, "paymentReceiptNumber": { "type": "string" }, "workerExperienceRating": { "type": "string" }, "workerFeedback": { "type": "string" }, "noShowExplanation": { "type": "string" }, "fixedTerm": { "type": "string" }, "fixedTermType": { "type": "string" }, "fixedTermExtensionPossible": { "type": "boolean" }, "rateType": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeInstanceDTO" } }, "requiredSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstanceDTO" } }, "desirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstanceDTO" } }, "requiredQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "desirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "requiredIndustries": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "desirableIndustries": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationInstance" } }, "roleType": { "$ref": "#/components/schemas/RoleType" }, "requiredSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "desirableSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "requiredQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "requiredIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "internalId": { "type": "string" }, "workstreamName": { "type": "string" }, "workstreamId": { "type": "string" }, "workstreamResourceId": { "type": "string" }, "resourcePlan": { "$ref": "#/components/schemas/ResourcePlanLine" }, "tentative": { "type": "boolean" }, "engagementName": { "type": "string" }, "engagementId": { "type": "string" }, "clientId": { "type": "string" }, "clientName": { "type": "string" }, "loading": { "type": "number", "format": "double" }, "linkedAssetIds": { "type": "array", "items": { "type": "string" } }, "hiringUserId": { "type": "string" }, "hiringUserName": { "type": "string" }, "costCenter": { "type": "string" }, "responsibleManagerId": { "type": "string" }, "responsibleManagerName": { "type": "string" }, "employerRating": { "type": "string" }, "linkedOnboardingRecordId": { "type": "string" }, "linkedOnboardingCompletedAt": { "type": "string", "format": "date-time" }, "linkedOnboardingOffboardedAt": { "type": "string", "format": "date-time" }, "linkedOnboardingAssociationType": { "type": "string" }, "linkedOnboardingRelationshipType": { "type": "string" }, "linkedOnboardingJobTitle": { "type": "string" }, "sex": { "type": "string" }, "likelihood": { "type": "number", "format": "double" }, "aiCandidateInsights": { "$ref": "#/components/schemas/AIJobCandidateInsightsDTO" }, "rightToWorkOnly": { "type": "boolean" }, "excludeVisaHolders": { "type": "boolean" }, "excludePermanentResidents": { "type": "boolean" }, "complianceProfileIds": { "type": "array", "items": { "type": "string" } }, "complianceProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceProfileDTO" } }, "note": { "type": "string" }, "tagsArray": { "type": "array", "items": { "type": "string" } } } }, "OrgDTO": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "string" }, "overview": { "type": "string" }, "logo": { "type": "string" }, "website": { "type": "string" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ImageDTO" } }, "address": { "$ref": "#/components/schemas/AddressDTO" }, "abn": { "type": "string", "maxLength": 16, "minLength": 5 }, "gstRegistered": { "type": "boolean" }, "abnName": { "type": "string" }, "abnType": { "type": "string" }, "abnStatus": { "type": "string" }, "abnTypeCode": { "type": "string" }, "abnStateCode": { "type": "string" }, "abnPostCode": { "type": "string" }, "asicNumber": { "type": "string" }, "verified": { "type": "boolean" }, "blockPublicPool": { "type": "boolean" }, "blockProviderServices": { "type": "boolean" }, "blockEmployeePublicProfiles": { "type": "boolean" }, "jobEmailsToNonOveeUsers": { "type": "boolean" }, "defaultJobBrowseEnabled": { "type": "boolean" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "associationTypes": { "type": "array", "items": { "type": "string" } }, "organisationServiceIds": { "type": "array", "items": { "type": "string" } }, "hasSubscription": { "type": "boolean" }, "subscriptionEndDate": { "type": "string", "format": "date" }, "subscriptionType": { "type": "string" }, "reciprocalSubscriptionAssociationFlags": { "type": "array", "items": { "type": "string" } }, "geminiAPIKey": { "type": "string" }, "geminiAPIKeySharedEntityStates": { "type": "array", "items": { "type": "string" } }, "geminiModel": { "type": "string" }, "geminiCvAIModel": { "type": "string" }, "geminiAssistantModel": { "type": "string" }, "addressOneLine": { "type": "string" }, "tagsArray": { "type": "array", "items": { "type": "string" } } } }, "ImageDTO": { "type": "object", "properties": { "id": { "type": "string" }, "image": { "type": "string" }, "url": { "type": "string" } } }, "PersonDTO": { "type": "object", "properties": { "id": { "type": "string" }, "archived": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "preferredFirstName": { "type": "string" }, "image": { "type": "string" }, "domain": { "type": "string" }, "domainId": { "type": "string" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "stars": { "type": "string" }, "location": { "type": "string" }, "skills": { "type": "string" }, "skillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "reviews": { "type": "string" }, "headline": { "type": "string" }, "overview": { "type": "string" }, "profileVideoUrl": { "type": "string" }, "experienceOverview": { "type": "string" }, "achievements": { "type": "string" }, "external": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDTO" } }, "declaredAvailability": { "type": "boolean" }, "declaredAvailableFrom": { "type": "string" }, "regularWorkingHours": { "$ref": "#/components/schemas/RegularWorkingHours" }, "availabilityStatus": { "type": "string" }, "availabilityFrom": { "type": "string" }, "availabilityUntil": { "type": "string" }, "availabilityCapacity": { "type": "string" }, "availabilityContinuity": { "type": "string" }, "availabilityIncludesTentative": { "type": "boolean" }, "availabilityGenerated": { "type": "boolean" }, "manualAvailableAfter": { "type": "boolean" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeDTO" } }, "sex": { "type": "string" }, "r2w": { "type": "string" }, "r2wVisaExpiryDate": { "type": "string", "format": "date" }, "dob": { "type": "string", "format": "date" }, "citizenship": { "type": "string" }, "orgAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/OrgAssociation" } }, "poolMemberships": { "type": "array", "items": { "$ref": "#/components/schemas/PoolMembershipSummaryDTO" } }, "nearbyAddress": { "$ref": "#/components/schemas/AddressDTO" }, "nearbyFormattedAddress": { "type": "string" }, "email": { "type": "string" }, "telephone": { "type": "string" }, "telegramChatId": { "type": "string" }, "emergencyContactName": { "type": "string" }, "emergencyContactEmail": { "type": "string" }, "emergencyContactPhoneNumber": { "type": "string" }, "qualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "highestDegreeId": { "type": "string" }, "yearsExperience": { "type": "string" }, "compensationExpectation": { "$ref": "#/components/schemas/CompensationExpectation" }, "compensationExpectations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationCompensationExpectation" } }, "employmentTypes": { "type": "array", "items": { "type": "string" } }, "orgIds": { "type": "string" }, "optPublic": { "type": "boolean" }, "blindProfile": { "type": "boolean" }, "tfn": { "type": "string" }, "abn": { "type": "string" }, "bankAccountName": { "type": "string" }, "bsb": { "type": "string" }, "bankAccountNumber": { "type": "string" }, "maxKMFromLocation": { "type": "integer", "format": "int32" }, "remoteWorkConsidered": { "type": "boolean" }, "relocationConsideredOptions": { "type": "array", "items": { "type": "string" } }, "travelConsideredOptions": { "type": "array", "items": { "type": "string" } }, "ownedById": { "type": "string" }, "ownedByOrg": { "type": "string" }, "ownedByName": { "type": "string" }, "userId": { "type": "string" }, "newProfile": { "type": "boolean" }, "oveeVerification": { "$ref": "#/components/schemas/OveeVerification" }, "organisationLocations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationLocationGroup" } }, "extraDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ExtraDetail" } }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } }, "publications": { "type": "array", "items": { "$ref": "#/components/schemas/Publication" } }, "personalInterests": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalInterest" } }, "willConsiderRemoteOptions": { "type": "array", "deprecated": true, "items": { "type": "string", "deprecated": true } }, "minHourlyRate": { "type": "string" }, "minYearlySalary": { "type": "string" }, "skillsArray": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" } } }, "TeamMemberDTO": { "type": "object", "properties": { "userId": { "type": "string" }, "displayIndex": { "type": "integer", "format": "int32" }, "position": { "type": "string" }, "image": { "type": "string" }, "name": { "type": "string" }, "personId": { "type": "string" } } }, "PersonCoreDTO": { "type": "object", "properties": { "value": { "type": "string" }, "archived": { "type": "boolean" }, "display": { "type": "string" }, "role": { "type": "string" } } }, "Pool": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "orgId": { "type": "string" }, "entityType": { "type": "string" }, "communityInvitationEnabled": { "type": "boolean" }, "communityInvitationScope": { "type": "string" }, "ownerId": { "type": "string" }, "ownerType": { "type": "string" }, "description": { "type": "string" }, "colour": { "type": "string" }, "image": { "type": "string" }, "favouriteUserIds": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "aiSearchCriteria": { "$ref": "#/components/schemas/CandidateSearchCriteraDTO" }, "aiCandidateInsights": { "$ref": "#/components/schemas/AIPoolCandidateInsightsDTO" }, "aiCandidateInsightsByRoleType": { "type": "array", "items": { "$ref": "#/components/schemas/PoolRoleTypeAIInsightsDTO" } }, "aiInsightsRunStatus": { "$ref": "#/components/schemas/PoolAIInsightsRunStatusDTO" }, "domainId": { "type": "string" }, "domainIds": { "type": "array", "items": { "type": "string" } }, "candidateFlowId": { "type": "string" }, "roleTypes": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTypeInstance" } }, "strictRoleTypes": { "type": "boolean" }, "roleTypeSelectionMode": { "type": "string", "enum": [ "APPLIED_FOR_ROLE_TYPE_ONLY", "ACTIVE_ROLE_TYPES", "ALL_ROLE_TYPES" ] }, "usePrimaryRoleTypesOnly": { "type": "boolean" }, "complianceProfileIds": { "type": "array", "items": { "type": "string" } }, "showUtilisationTab": { "type": "boolean" }, "automaticAiInsightsRefreshEnabled": { "type": "boolean" }, "score": { "type": "number", "format": "float" }, "createdDate": { "type": "string", "format": "date-time" }, "demoData": { "type": "boolean" }, "demoDataBatchId": { "type": "string" }, "peopleCriteria": { "$ref": "#/components/schemas/CandidateSearchCriteraDTO", "writeOnly": true } }, "required": [ "name" ] }, "SkillInstanceDTO": { "type": "object", "properties": { "skillId": { "type": "string" }, "title": { "type": "string" }, "proficiency": { "type": "integer", "format": "int32" }, "primary": { "type": "boolean" }, "softSkill": { "type": "boolean" }, "technicalSkill": { "type": "boolean" } } }, "ResourcePlanLine": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "roleName": { "type": "string" }, "domainId": { "type": "string" }, "rank": { "$ref": "#/components/schemas/Rank" }, "roleType": { "$ref": "#/components/schemas/RoleType" }, "who": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceWho" } }, "source": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceSource" } }, "startDate": { "type": "string", "format": "date" }, "latestStartDate": { "type": "string", "format": "date" }, "overrideProjectStartDates": { "type": "boolean" }, "endDate": { "type": "string", "format": "date" }, "totalDays": { "type": "integer", "format": "int32" }, "totalHours": { "type": "integer", "format": "int32" }, "breakdown": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "title": { "type": "string" }, "term": { "type": "string" }, "termType": { "type": "string" }, "loading": { "type": "number", "format": "double" }, "tentative": { "type": "boolean" }, "provisioningFlow": { "type": "string" }, "provisioningJobType": { "type": "string" }, "overrideProjectProvisioningJobType": { "type": "boolean" }, "linkedPoolId": { "type": "string" }, "linkedPoolName": { "type": "string" }, "directPerson": { "$ref": "#/components/schemas/ResourceWho" }, "requiredSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "desirableSkillsList": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "requiredQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableQualificationsList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "requiredIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "desirableIndustriesList": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "workplaceOption": { "type": "array", "items": { "type": "string" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/OrgLocation" } }, "minRoleExperienceYears": { "type": "number", "format": "double" } }, "required": [ "startDate" ] }, "Rank": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domainId": { "type": "string" } }, "required": [ "name" ] }, "ResourceWho": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "pool": { "type": "boolean" } } }, "ResourceSource": { "type": "object", "properties": { "name": { "type": "string" } } }, "OrgLocation": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "formattedAddress": { "type": "string" }, "locationDescription": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "orgId": { "type": "string" } } }, "AIJobCandidateInsightsDTO": { "type": "object", "properties": { "jobId": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "candidatesSentToAI": { "type": "integer", "format": "int32" }, "stepInsights": { "type": "array", "items": { "$ref": "#/components/schemas/StepInsight" } }, "candidateInsights": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateInsight" } } } }, "StepInsight": { "type": "object", "properties": { "step": { "type": "string" }, "summary": { "type": "string" }, "noStrongMatch": { "type": "boolean" }, "noStrongMatchReason": { "type": "string" }, "rankedCandidates": { "type": "array", "items": { "$ref": "#/components/schemas/RankedCandidate" } }, "topCandidates": { "type": "array", "items": { "$ref": "#/components/schemas/TopCandidate" } } } }, "RankedCandidate": { "type": "object", "properties": { "candidateId": { "type": "string" }, "candidateName": { "type": "string" }, "aiCandidateRank": { "type": "integer", "format": "int32" }, "aiSuitabilityScore": { "type": "integer", "format": "int32" }, "aiSuitabilityJustification": { "type": "string" } } }, "JobCandidateWithPersonDTO": { "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "who": { "type": "string" }, "dateTime": { "type": "string" }, "state": { "type": "string" }, "assignmentJobId": { "type": "string" }, "proposedRate": { "type": "string" }, "proposedStartDate": { "type": "string", "format": "date-time" }, "notes": { "type": "integer", "format": "int32" }, "personStatus": { "type": "string" }, "poolTag": { "type": "string" }, "poolTags": { "type": "array", "items": { "$ref": "#/components/schemas/PoolPersonTagItemDTO" } }, "interested": { "type": "boolean" }, "previousState": { "type": "string" }, "score": { "type": "number", "format": "double" }, "missingSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "missingDesirableSkills": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInstance" } }, "missingDesirableQualifications": { "type": "array", "items": { "$ref": "#/components/schemas/Qualification" } }, "aiInsights": { "type": "array", "items": { "type": "string" } }, "orgUserNotes": { "type": "array", "items": { "type": "string" } }, "aiCandidateRank": { "type": "integer", "format": "int32" }, "complianceAssessment": { "$ref": "#/components/schemas/PoolPersonComplianceDTO" }, "person": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDTO" } } } } } } }