{ "openapi": "3.1.0", "paths": { "/connect_sessions": { "post": { "description": "Creates a short-lived connect session and returns the token and auth link that open the account-linking flow for one end-user.", "operationId": "stackone_create_connect_session", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectSessionCreate" } } } }, "responses": { "201": { "description": "The details of the connect session created with token and auth link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectSessionTokenAuthLink" } } } }, "400": { "description": "Could not create a connect session as the provider is not enabled on this project\n\nInvalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Create Connect Session", "tags": [ "Connect Sessions" ], "x-speakeasy-name-override": "create_connect_session", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connect_sessions/{id}": { "get": { "description": "Returns a connect session and the state of its most recent connection attempt.", "operationId": "stackone_get_connect_session", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "The connect session, including the most recent connection attempt (use latest_connection_attempt.status to poll for OAuth completion).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectSession" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "No connect session with that id exists in this project.\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Connect Session", "tags": [ "Connect Sessions" ], "x-speakeasy-name-override": "get_connect_session", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connect_sessions/authenticate": { "post": { "description": "Exchanges a connect session token for the session it belongs to.", "operationId": "stackone_authenticate_connect_session", "parameters": [], "requestBody": { "required": true, "description": "The parameters to authenticate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectSessionAuthenticate" } } } }, "responses": { "201": { "description": "The details of the authenticated connect session.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectSession" } } } }, "400": { "description": "Could not authenticate the connect session as the provider is not enabled on this project\n\nInvalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Authenticate Connect Session", "tags": [ "Connect Sessions" ], "x-speakeasy-name-override": "authenticate_connect_session", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/accounts": { "get": { "operationId": "stackone_list_linked_accounts", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "The page number of the results to fetch", "schema": { "nullable": true, "type": "number" } }, { "name": "page_size", "required": false, "in": "query", "description": "The number of results per page", "schema": { "nullable": true, "default": 25, "type": "number" } }, { "name": "provider", "required": false, "in": "query", "description": "The provider of the results to fetch", "deprecated": true, "schema": { "nullable": true, "type": "string" } }, { "name": "origin_owner_id", "required": false, "in": "query", "description": "The origin owner identifier of the results to fetch", "schema": { "nullable": true, "type": "string" } }, { "name": "origin_owner_ids", "required": false, "in": "query", "description": "The origin owner identifiers of the results to fetch (supports multiple IDs)", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "providers", "required": false, "in": "query", "description": "The providers list of the results to fetch", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "account_ids", "required": false, "in": "query", "description": "The providers list of the results to fetch", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "required": false, "in": "query", "description": "The status of the results to fetch", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "The list of accounts was retrieved.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/LinkedAccountsPaginated" }, { "type": "array", "items": { "$ref": "#/components/schemas/LinkedAccount" } } ] } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Accounts", "tags": [ "Accounts" ], "x-speakeasy-name-override": "list_linked_accounts", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/accounts/{id}": { "get": { "operationId": "stackone_get_account", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The account with the given identifier was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Account", "tags": [ "Accounts" ], "x-speakeasy-name-override": "get_account", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } }, "patch": { "operationId": "stackone_update_account", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAccountExternalDto" } } } }, "responses": { "200": { "description": "The account with the given identifier was updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Update Account", "tags": [ "Accounts" ], "x-speakeasy-name-override": "update_account", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } }, "delete": { "operationId": "stackone_delete_account", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The account with the given identifier was deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "The account with the given identifier does not exist\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Delete Account", "tags": [ "Accounts" ], "x-speakeasy-name-override": "delete_account", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/accounts/{id}/meta": { "get": { "deprecated": true, "operationId": "stackone_get_account_meta_info", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The meta information of the account was retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountMeta" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "The account with the given identifier does not exist\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Account Meta Information (Legacy)", "tags": [ "Accounts" ], "x-speakeasy-name-override": "get_account_meta_info", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs": { "post": { "description": "Returns a paginated list of logs. Each log includes a `log_type` discriminator field with possible values: `action` or `unified`. Use the `log_type` filter to request specific types.", "operationId": "stackone_list_logs", "parameters": [ { "name": "expand", "required": false, "in": "query", "description": "A comma-separated list of additional fields to expand. Supported values: `connector` (the connector display data — name, logo, categories — for each row). Omitted unless requested, as resolving it is more expensive. `connector_key`, `connector_version` and `connector_owner` are always returned regardless.", "schema": { "nullable": true, "example": "connector", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsPostDto" } } } }, "responses": { "200": { "description": "The list of logs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions": { "post": { "description": "Returns a paginated list of action logs. Each row summarises a single action or RPC execution and includes an `action_run_id` for drilling into its detail, steps, and advanced payloads.", "operationId": "stackone_list_action_logs", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogsPostDto" } } } }, "responses": { "200": { "description": "The list of action logs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Action Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_action_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/steps": { "post": { "description": "Returns a paginated list of connector execution steps across action runs. Each action runs as one or more steps; use this to find steps without first selecting an action run.", "operationId": "stackone_list_step_logs", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepsLogsPostDto" } } } }, "responses": { "200": { "description": "The list of step logs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepLogsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Step Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_step_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}": { "get": { "description": "Returns the full metadata for a single action run identified by `action_run_id` — status, duration, connector, account, action, and event time. Use after locating an `action_run_id` from List Action Logs.", "operationId": "stackone_get_action_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The action log was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLog" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Action Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_action_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/steps": { "get": { "description": "Returns the connector execution steps for a single action run, in execution order. Use to examine the individual steps of a request when debugging a failure.", "operationId": "stackone_list_action_step_logs", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "page_size", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Action Step Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_action_step_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/steps/{stepIndex}": { "get": { "description": "Returns the metadata for a single step within an action run, identified by its `step_index`.", "operationId": "stackone_get_step_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "stepIndex", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Step Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_step_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/advanced": { "get": { "description": "Returns the full HTTP request and response bodies for an action run. Fetch on demand when inspecting payloads — not for every row, as advanced logs are large.", "operationId": "stackone_get_action_advanced_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Action Advanced Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_action_advanced_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/steps/{stepIndex}/advanced": { "get": { "description": "Returns the full request and response bodies for a single step of an action run, identified by `action_run_id` and `step_index`.", "operationId": "stackone_get_step_advanced_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "stepIndex", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Step Advanced Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_step_advanced_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/defender": { "get": { "description": "Returns StackOne Defender scan results for an action run, including the risk classification and scores. Available when Defender is enabled; use to review the security assessment of AI agent tool calls.", "operationId": "stackone_get_action_defender_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Action Defender Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_action_defender_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/actions/{actionRunId}/policy": { "get": { "description": "Returns the runtime policy decision recorded for an action run: the rules that decided, the version each was at when it decided, the level that decided, the acting principal, and anything a monitored rule observed. Available when the request was evaluated by the policy layer, which the log row reports through `policy_result`.", "operationId": "stackone_get_action_policy_log", "parameters": [ { "name": "actionRunId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The policy decision was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyLog" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Action Policy Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_action_policy_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified": { "post": { "description": "Returns a paginated list of unified request logs — StackOne-normalized API requests.", "operationId": "stackone_list_unified_logs", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedLogsPostDto" } } } }, "responses": { "200": { "description": "The list of unified logs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedLogsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Unified Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_unified_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified/{requestId}": { "get": { "description": "Returns the metadata for a single unified request log identified by `request_id`.", "operationId": "stackone_get_unified_log", "parameters": [ { "name": "requestId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The unified log was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedLog" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Unified Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_unified_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified/{requestId}/provider": { "get": { "description": "Returns the underlying provider requests StackOne made while serving a single unified request, identified by `request_id`.", "operationId": "stackone_list_unified_provider_logs", "parameters": [ { "name": "requestId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "page", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "page_size", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Unified Provider Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_unified_provider_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified/{requestId}/provider/{id}": { "get": { "description": "Returns the metadata for a single provider request made while serving a unified request, identified by the unified `request_id` and the provider log `id`.", "operationId": "stackone_get_provider_log", "parameters": [ { "name": "requestId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Provider Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_provider_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified/{requestId}/advanced": { "get": { "description": "Returns the full request and response bodies for a single unified request, identified by `request_id`.", "operationId": "stackone_get_unified_advanced_log", "parameters": [ { "name": "requestId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Unified Advanced Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_unified_advanced_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/unified/{requestId}/provider/{id}/advanced": { "get": { "description": "Returns the full request and response bodies for a single provider request made while serving a unified request, identified by the unified `request_id` and the provider log `id`.", "operationId": "stackone_get_provider_advanced_log", "parameters": [ { "name": "requestId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Provider Advanced Log", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_provider_advanced_log", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/provider": { "post": { "description": "Returns a paginated list of provider request logs — the raw requests StackOne sent to the downstream provider.", "operationId": "stackone_list_provider_logs", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderLogsPostDto" } } } }, "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Provider Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_provider_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/platform": { "post": { "description": "Returns a paginated list of platform logs — the audit trail of operations on StackOne itself, such as creating an account or deleting an integration, as opposed to requests proxied to a provider. Filter `resource` for everything that happened to a kind of thing (`account`), `resource_id` for everything that happened to one of them, and `action` for a kind of operation (`create`). `event_type` carries the pair as one value (`account_create`) and remains filterable. A few operations are not tied to a resource — the AI and playground routes — and their `event_type` is the bare action (`check`, `playground_build`) with `resource` unset. Requires access to every account in the project: a member restricted to a subset of accounts is refused, because the trail cannot be meaningfully filtered to their accounts and its rows can reveal activity on accounts they cannot read.", "operationId": "stackone_list_platform_logs", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformLogsPostDto" } } } }, "responses": { "200": { "description": "The list of platform logs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformLogsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "The caller is restricted to a subset of the project's accounts. Reading platform logs requires access to all of them.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Platform Logs", "tags": [ "Logs" ], "x-speakeasy-name-override": "list_platform_logs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/stats/aggregate": { "post": { "description": "Returns aggregated log metrics — request volume, error counts, and latency — optionally grouped by one or more dimensions and bucketed into time intervals. Use for dashboards and trends instead of listing individual rows.", "operationId": "stackone_get_logs_stats_aggregate", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregationPostDto" } } } }, "responses": { "200": { "description": "" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Logs Stats Aggregate", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_logs_stats_aggregate", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/stats/dimensions": { "post": { "description": "Returns the distinct values available for the requested dimensions (for example connector, account, or status code). Use to populate filter controls and build breakdowns. Values of the `connector_key` dimension also carry a `label` holding the connector display name.", "operationId": "stackone_get_logs_stats_dimensions", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DimensionsPostDto" } } } }, "responses": { "200": { "description": "The dimension values were retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsDimensions" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Logs Stats Dimensions", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_logs_stats_dimensions", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/logs/platform/dimensions": { "post": { "description": "Returns the distinct values available for the requested platform-log dimensions (for example event type, actor, or source), with a count of matching events for each. Use to populate the filter controls on the platform trail without first reading a page of it. Pass `filters` to narrow the values to the rows a listing with those same filters would return, so the counts describe what the caller is looking at. Requires access to every account in the project, for the same reason listing the trail does.", "operationId": "stackone_get_platform_log_dimensions", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformDimensionsPostDto" } } } }, "responses": { "200": { "description": "The platform log dimension values were retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogsDimensions" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "The caller is restricted to a subset of the project's accounts. Reading platform logs requires access to all of them.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Platform Log Dimensions", "tags": [ "Logs" ], "x-speakeasy-name-override": "get_platform_log_dimensions", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/auth_configs": { "get": { "deprecated": true, "description": "List the auth configs available to the project. Deprecated: use `GET /connector_profiles` instead.", "operationId": "stackone_list_auth_configs", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "The page number of the results to fetch", "schema": { "nullable": true, "type": "number" } }, { "name": "page_size", "required": false, "in": "query", "description": "The number of results per page", "schema": { "nullable": true, "default": 25, "type": "number" } }, { "name": "enabled", "required": false, "in": "query", "description": "Filter auth configs by their enabled state", "schema": { "nullable": true, "example": true, "type": "boolean" } }, { "name": "connector_key", "required": false, "in": "query", "description": "Filter auth configs by connector key", "schema": { "nullable": true, "example": "salesforce", "type": "string" } } ], "responses": { "200": { "description": "The list of auth configs was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthConfigsPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Auth Configs", "tags": [ "Auth Configs" ], "x-speakeasy-name-override": "list_auth_configs", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connector_profiles": { "get": { "description": "List the connector profiles available to the project.", "operationId": "stackone_list_connector_profiles", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "The page number of the results to fetch", "schema": { "nullable": true, "type": "number" } }, { "name": "page_size", "required": false, "in": "query", "description": "The number of results per page", "schema": { "nullable": true, "default": 25, "type": "number" } }, { "name": "enabled", "required": false, "in": "query", "description": "Filter connector profiles by their enabled state", "schema": { "nullable": true, "example": true, "type": "boolean" } }, { "name": "connector_key", "required": false, "in": "query", "description": "Filter connector profiles by connector key", "schema": { "nullable": true, "example": "salesforce", "type": "string" } } ], "responses": { "200": { "description": "The list of connector profiles was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorProfilesPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Connector Profiles", "tags": [ "Connector Profiles" ], "x-speakeasy-name-override": "list_connector_profiles", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connector_profiles/{connectorProfileId}/pinned_version": { "get": { "description": "Get the pinned connector version for the given connector profile.", "operationId": "stackone_get_connector_profile_pinned_version", "parameters": [ { "name": "connectorProfileId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The pinned version for the connector profile was retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorProfilePinnedVersion" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "No pinned version was found for the connector profile.\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Connector Profile Pinned Version", "tags": [ "Connector Profiles" ], "x-speakeasy-name-override": "get_connector_profile_pinned_version", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } }, "put": { "description": "Create or update the pinned connector version for the given connector profile.", "operationId": "stackone_upsert_connector_profile_pinned_version", "parameters": [ { "name": "connectorProfileId", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertConnectorProfilePinnedVersion" } } } }, "responses": { "200": { "description": "The pinned version for the connector profile was created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorProfilePinnedVersion" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "The connector profile was not found, or the requested version does not exist in the registry.\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Upsert Connector Profile Pinned Version", "tags": [ "Connector Profiles" ], "x-speakeasy-name-override": "upsert_connector_profile_pinned_version", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } }, "delete": { "description": "Remove the pinned connector version for the given connector profile.", "operationId": "stackone_delete_connector_profile_pinned_version", "parameters": [ { "name": "connectorProfileId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The pinned version for the connector profile was removed." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "No pinned version was found for the connector profile.\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Delete Connector Profile Pinned Version", "tags": [ "Connector Profiles" ], "x-speakeasy-name-override": "delete_connector_profile_pinned_version", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connector_profiles/{connectorProfileId}/versions": { "get": { "description": "List the connector versions available for the given connector profile, indicating which one is currently pinned.", "operationId": "stackone_list_connector_profile_versions", "parameters": [ { "name": "connectorProfileId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The list of connector versions for the connector profile was retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorProfileVersion" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "The connector profile or its pinned connector version was not found in the registry.\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Connector Profile Versions", "tags": [ "Connector Profiles" ], "x-speakeasy-name-override": "list_connector_profile_versions", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connectors/meta": { "get": { "deprecated": true, "operationId": "stackone_list_connectors_meta", "parameters": [ { "name": "include", "required": false, "in": "query", "description": "The comma separated list of data that will be included in the response", "schema": { "nullable": true, "example": "field_path,unmapped_fields,resources,inactive,webhooks,static_fields", "type": "string" } } ], "responses": { "200": { "description": "The list of connectors meta information was retrieved.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorsMeta" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List Connector Meta Information (Legacy)", "tags": [ "Connectors" ], "x-speakeasy-name-override": "list_connectors_meta", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/connectors/meta/{provider}": { "get": { "deprecated": true, "operationId": "stackone_get_connector_meta", "parameters": [ { "name": "provider", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "include", "required": false, "in": "query", "description": "The comma separated list of data that will be included in the response", "schema": { "nullable": true, "example": "field_path,unmapped_fields,resources,inactive,webhooks,static_fields", "type": "string" } } ], "responses": { "200": { "description": "The connector meta information was retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorsMeta" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "No connector with the given provider key exist\n\nResource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Get Connector Meta Information (Legacy)", "tags": [ "Connectors" ], "x-speakeasy-name-override": "get_connector_meta", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/mcp": { "post": { "description": "Send JSON-RPC request to the MCP server over HTTP streaming transport", "operationId": "stackone_mcp_post", "parameters": [ { "name": "x-account-id", "in": "header", "description": "Account secure id for the target provider account (optional if x-account-id query parameter is provided)", "required": false, "schema": { "type": "string" } }, { "name": "apps", "required": false, "in": "query", "description": "MCP Apps panel: \"off\" (default) omits it, \"on\" registers the interactive toolset explorer. Only set it for hosts that render MCP Apps — a client with no iframe (a terminal) gets a tool whose result it cannot display", "schema": { "enum": [ "on", "off" ], "type": "string" } }, { "name": "instructions", "required": false, "in": "query", "description": "Server `instructions` (returned in the MCP initialize handshake) that teach the model the path/query/body/headers parameter envelope: \"off\" (default) omits them, \"on\" includes envelope guidance matched to the active param-style", "schema": { "enum": [ "on", "off" ], "type": "string" } }, { "name": "param-style", "required": false, "in": "query", "description": "Parameter schema style: \"flat_prefixed\" (default) flattens with location prefix, \"nested\" groups by location, \"flat_smart\" flattens and only prefixes on name collision", "schema": { "enum": [ "nested", "flat_prefixed", "flat_smart" ], "type": "string" } }, { "name": "tool-mode", "required": false, "in": "query", "description": "Tool registration mode: \"individual\" (default) registers each action as a separate tool; \"search_execute\" registers two tools per linked account for a search-then-execute flow", "schema": { "enum": [ "individual", "search_execute" ], "type": "string" } }, { "name": "x-account-id", "required": false, "in": "query", "description": "Account secure id (alternative to x-account-id header)", "schema": {} }, { "name": "Accept", "in": "header", "description": "Must list both application/json and text/event-stream, which the Streamable HTTP spec requires of a client; anything else is rejected with 406. The response itself is always application/json: this server answers in JSON mode and never opens an SSE stream.", "required": true, "schema": { "type": "string", "default": "application/json, text/event-stream", "example": "application/json, text/event-stream" } } ], "requestBody": { "required": true, "description": "JSON-RPC 2.0 message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcMessageDto" }, "examples": { "initialize": { "summary": "initialize (capability handshake; no session is created)", "value": { "jsonrpc": "2.0", "method": "initialize", "params": { "clientInfo": { "name": "my-client", "version": "1.0.0" }, "protocolVersion": "2025-03-26", "capabilities": {} }, "id": "init-1" } }, "toolsList": { "summary": "tools/list — list available tools", "value": { "jsonrpc": "2.0", "method": "tools/list", "params": {}, "id": "list-1" } }, "toolsCall": { "summary": "tools/call — call a tool (individual mode)", "value": { "jsonrpc": "2.0", "method": "tools/call", "params": { "name": "unified_hris_list_employees", "arguments": {} }, "id": "call-1" } }, "toolsCallSearchExecute": { "summary": "tools/call — search for an action (search_execute mode)", "value": { "jsonrpc": "2.0", "method": "tools/call", "params": { "name": "googlecalendar__search_actions", "arguments": { "query": "list calendar events", "top_k": 1 } }, "id": "search-1" } }, "toolsCallExecuteAction": { "summary": "tools/call — execute an action (search_execute mode)", "value": { "jsonrpc": "2.0", "method": "tools/call", "params": { "name": "googlecalendar__execute_action", "arguments": { "action_name": "googlecalendar_list_events", "query_params": { "calendarId": "primary" } } }, "id": "execute-1" } } } } } }, "responses": { "200": { "description": "Processed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "nullable": true, "description": "Echoes the id from the request. null for protocol-level errors where the id could not be determined." }, "result": { "nullable": true, "description": "Present on success. Shape varies by method — see response examples." }, "error": { "type": "object", "description": "Present on protocol-level failure. Tool-level failures use result with isError: true instead.", "properties": { "code": { "type": "number", "example": -32600 }, "message": { "type": "string", "example": "Invalid request" }, "data": { "description": "Additional error context", "nullable": true } } } } }, "examples": { "initialize": { "summary": "initialize (capabilities negotiated)", "value": { "jsonrpc": "2.0", "id": "init-1", "result": { "protocolVersion": "2025-03-26", "capabilities": { "tools": { "listChanged": true } }, "serverInfo": { "name": "stackone-mcp-server", "version": "1.0.1", "title": "StackOne", "description": "Give AI agents 30,000+ safe, token-optimized actions across Workday, SAP, Oracle + hundreds more.", "websiteUrl": "https://www.stackone.com", "icons": [ { "src": "https://stackone-logos.com/api/stackone/icon/png", "mimeType": "image/png", "sizes": [ "200x200" ] }, { "src": "https://www.stackone.com/favicon.svg", "mimeType": "image/svg+xml", "sizes": [ "any" ] } ] } } } }, "toolsList": { "summary": "tools/list — tool listing", "value": { "jsonrpc": "2.0", "id": "list-1", "result": { "tools": [ { "name": "unified_hris_list_employees", "description": "List employees", "inputSchema": { "type": "object", "properties": { "query": { "type": "object", "properties": { "page_size": { "type": "number" }, "next_cursor": { "type": "string" } } } } } } ] } } }, "toolsCallSuccess": { "summary": "tools/call — success", "value": { "jsonrpc": "2.0", "id": "call-1", "result": { "content": [ { "type": "text", "text": "{\"isError\":false,\"result\":{\"data\":[{\"id\":\"emp_01\",\"name\":\"Jane Smith\"}],\"next_cursor\":null}}" } ], "isError": false, "structuredContent": { "isError": false, "result": { "data": [ { "id": "emp_01", "name": "Jane Smith" } ], "next_cursor": null } } } } }, "toolsCallError": { "summary": "tools/call — tool-level error", "value": { "jsonrpc": "2.0", "id": "call-1", "result": { "content": [ { "type": "text", "text": "{\"isError\":true,\"result\":{\"error\":\"Resource not found\",\"status_code\":404,\"error_category\":\"not_found\",\"retryable\":false}}" } ], "isError": true, "structuredContent": { "isError": true, "result": { "error": "Resource not found", "status_code": 404, "error_category": "not_found", "retryable": false } } } } }, "protocolError": { "summary": "Protocol-level error", "value": { "jsonrpc": "2.0", "id": null, "error": { "code": -32600, "message": "Invalid request" } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "412": { "description": "Precondition failed: the linked account is suspended, expired, archived, or in an error state. `errorCode` identifies which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] }, { "ApiKey": [] } ], "summary": "Send MCP JSON-RPC message", "tags": [ "MCP" ], "x-speakeasy-name-override": "mcp_post", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/actions": { "get": { "description": "Retrieves metadata for all connectors and their actions available on the platform. Use this endpoint to discover which connectors and actions are available, including those that have not yet been configured, for example to display the full catalog of integrations and actions.", "operationId": "stackone_list_actions_meta", "parameters": [ { "name": "page_size", "required": false, "in": "query", "description": "The number of results per page (default value is 25)", "schema": { "nullable": true, "type": "string" } }, { "name": "next", "required": false, "in": "query", "description": "The unified cursor", "schema": { "nullable": true, "type": "string" } }, { "name": "group_by", "required": false, "in": "query", "description": "The relation to group the results by", "schema": { "nullable": true, "default": "connector", "example": [ "connector" ], "type": "string" } }, { "name": "filter", "required": false, "in": "query", "description": "Actions Metadata filters", "explode": true, "style": "deepObject", "schema": { "properties": { "connectors": { "description": "A comma-separated list of connectors to filter the results by.", "example": "connector1,connector2", "type": "string", "nullable": true, "additionalProperties": false }, "account_ids": { "description": "A comma-separated list of account IDs to filter the results by.", "example": "account1,account2", "type": "string", "nullable": true, "additionalProperties": false }, "action_key": { "description": "The action key to filter the results by", "example": "action1", "type": "string", "nullable": true, "additionalProperties": false } }, "nullable": true, "type": "object" } }, { "name": "include", "required": false, "in": "query", "description": "Additional data to include in the response", "schema": { "nullable": true, "example": [ "action_details", "authentication_guides", "event_guides" ], "type": "array", "items": { "type": "string", "enum": [ "action_details", "authentication_guides", "event_guides" ] } } }, { "name": "search", "required": false, "in": "query", "description": "Text search across provider names, action labels, and action descriptions", "schema": { "nullable": true, "example": "employee", "type": "string" } }, { "name": "exclude", "required": false, "in": "query", "description": "Data to exclude from the response", "schema": { "nullable": true, "example": [ "actions" ], "type": "array", "items": { "type": "string", "enum": [ "actions" ] } } } ], "responses": { "200": { "description": "List of actions metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsMetaPaginated" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "List all connectors & actions metadata", "tags": [ "Actions" ], "x-speakeasy-name-override": "list_actions_meta", "x-speakeasy-pagination": { "type": "cursor", "inputs": [ { "name": "next", "in": "parameters", "type": "cursor" } ], "outputs": { "nextCursor": "$.next" } }, "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/actions/search": { "post": { "description": "Ranks the project's connector actions by how closely they match a natural-language query, so an agent can find the right action without reading the whole catalog.", "operationId": "stackone_search_actions", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionSearchDto" } } } }, "responses": { "200": { "description": "Search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionSearchResponseDto" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Search connector actions by semantic similarity", "tags": [ "Actions" ], "x-speakeasy-name-override": "search_actions", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/actions/build": { "post": { "operationId": "stackone_build_action_embeddings", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionBuildDto" } } } }, "responses": { "200": { "description": "Build result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionBuildResponseDto" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Rebuild action embeddings for semantic search", "tags": [ "Actions" ], "x-speakeasy-name-override": "build_action_embeddings", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/actions/rpc": { "post": { "description": "Makes a remote procedure call to the specified action", "operationId": "stackone_rpc_action", "parameters": [ { "name": "debug", "required": false, "in": "query", "description": "Enable debug mode for the action execution", "schema": { "nullable": true, "example": false, "type": "boolean" } }, { "name": "x-account-id", "in": "header", "description": "The account identifier", "required": true, "schema": { "type": "string" } }, { "name": "x-connector-profile-id", "in": "header", "description": "Overrides the connector profile associated with the account for this request. The profile must exist in the same project and belong to the same connector as the account, otherwise the request is rejected with a 400 Bad Request.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsRpcRequestDto" } } } }, "responses": { "200": { "description": "Action response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsRpcResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "412": { "description": "Precondition failed: the linked account is suspended, expired, archived, or in an error state. `errorCode` identifies which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Make an RPC call to an action", "tags": [ "Actions" ], "x-speakeasy-name-override": "rpc_action", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/actions/rpc/synced": { "post": { "description": "Returns previously synced data for an action, read from the Data Sync index rather than the provider. Responds with a refusal when no sync can be selected to serve the read.", "operationId": "stackone_rpc_action_synced", "parameters": [ { "name": "page_size", "required": false, "in": "query", "description": "The number of results to return per page (minimum 1, maximum 200, default 100)", "schema": { "minimum": 1, "maximum": 200, "nullable": true, "example": 25, "type": "number" } }, { "name": "skip", "required": false, "in": "query", "description": "The number of results to skip before returning results. skip + page_size cannot exceed 10000 (page_size defaulting to 100 when omitted); narrow the filter to reach records beyond that.", "schema": { "minimum": 0, "nullable": true, "example": 0, "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsRpcSyncedRequestDto" } } } }, "responses": { "200": { "description": "Synced action data, or a refusal payload explaining why none was returned.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ActionsSyncedResponse" }, { "$ref": "#/components/schemas/ActionsSyncedRefusal" } ] } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "412": { "description": "Precondition failed: the linked account is suspended, expired, archived, or in an error state. `errorCode` identifies which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Read synced action data from the datasync index", "tags": [ "Actions" ], "x-speakeasy-name-override": "rpc_action_synced", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/unified/proxy": { "post": { "deprecated": true, "operationId": "stackone_proxy_request", "parameters": [ { "name": "x-account-id", "in": "header", "description": "The account identifier", "required": true, "schema": { "type": "string" } }, { "name": "Prefer", "in": "header", "required": false, "description": "Set to \"heartbeat\" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)", "schema": { "type": "string", "example": "heartbeat" } } ], "requestBody": { "required": true, "description": "The request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyRequestBody" } } } }, "responses": { "200": { "description": "The proxy request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyResponseApiModel" } } } }, "201": { "description": "Resource was successfully created by the target service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyResponseApiModel" } } } }, "202": { "description": "Request accepted by the target service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyResponseApiModel" } } } }, "204": { "description": "Request succeeded with no content.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyResponseApiModel" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "412": { "description": "Precondition failed: the linked account is suspended, expired, archived, or in an error state. `errorCode` identifies which.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Proxy Request (Legacy)", "tags": [ "Proxy" ], "x-speakeasy-name-override": "proxy_request", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } }, "/unified/check_permissions": { "post": { "description": "Checks what permissions a user has on a given resource. Delegates to the connected provider's `unified_check_permissions` action.", "operationId": "stackone_check_permissions", "parameters": [ { "name": "x-account-id", "in": "header", "description": "The account identifier", "required": true, "schema": { "type": "string" } }, { "name": "Prefer", "in": "header", "required": false, "description": "Set to \"heartbeat\" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)", "schema": { "type": "string", "example": "heartbeat" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckPermissionsRequestDto" } } } }, "responses": { "200": { "description": "Permission check result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckPermissionsResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "408": { "description": "The request has timed out.", "headers": { "Retry-After": { "description": "A time in seconds after which the request can be retried.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { "description": "Conflict with current state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictResponse" } } } }, "422": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { "description": "Server error while executing the request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { "description": "This functionality is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotImplementedResponse" } } } }, "502": { "description": "Bad gateway error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadGatewayResponse" } } } } }, "security": [ { "basic": [] } ], "summary": "Check user permissions on a resource", "tags": [ "Actions" ], "x-speakeasy-name-override": "check_permissions", "x-speakeasy-retries": { "statusCodes": [ 429, 408 ], "strategy": "backoff" } } } }, "info": { "title": "StackOne", "description": "The documentation for the StackOne API", "version": "1.0.0", "contact": {} }, "tags": [ { "name": "Accounts", "description": "View and manage linked accounts." }, { "name": "Actions", "description": "Retrieve Actions metadata and definitions." }, { "name": "AI", "description": "AI-powered features." }, { "name": "Auth Configs", "description": "View and manage connector auth configurations for the project." }, { "name": "Connect Sessions", "description": "Generate connection session tokens or auth URLs to allow your customers to connect their accounts." }, { "name": "Connector Profiles", "description": "View and manage connector profiles for the project." }, { "name": "Connectors", "description": "Retrieve metadata for connectors." }, { "name": "Logs", "description": "API request logs and analytics." }, { "name": "MCP", "description": "Model Context Protocol endpoint." }, { "name": "Proxy", "description": "Routing API requests through StackOne directly to the underlying provider." }, { "name": "Request Logs", "description": "API requests and response logs." }, { "name": "Webhooks", "description": "Configure and manage webhooks." } ], "servers": [ { "url": "https://api.stackone.com" } ], "components": { "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } }, "schemas": { "ActionBuildDto": { "type": "object", "properties": { "connector_key": { "type": "string", "description": "Specific connector key to rebuild embeddings for", "example": "slack" }, "force_refresh": { "type": "boolean", "description": "Force refresh - clear all existing embeddings before rebuilding", "default": false } } }, "ActionBuildResponseDto": { "type": "object", "properties": { "status": { "type": "string", "description": "Build status", "enum": [ "accepted", "success", "error" ], "example": "accepted" }, "message": { "type": "string", "description": "Status message" }, "actions_indexed": { "type": "number", "description": "Number of actions indexed (only for synchronous builds)" }, "connector_filter": { "type": "string", "description": "Connector filter applied" }, "connectors_dispatched": { "description": "Connector keys the build fanned out to, when no `connector_key` was given. Absent for a single-connector build.", "example": [ "slack", "hubspot" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "description": "Error message if status is error" } }, "required": [ "status" ] }, "ActionLog": { "type": "object", "properties": { "log_id": { "type": "string", "description": "The unique log identifier", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "log_type": { "type": "string", "description": "The type of log", "enum": [ "action" ], "example": "action", "x-speakeasy-unknown-values": "allow" }, "event_time": { "type": "string", "description": "The event ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "start_time": { "type": "string", "description": "The request start time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "description": "The request end time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "duration_ms": { "type": "number", "description": "The duration in milliseconds", "example": 356, "nullable": true }, "project_id": { "type": "string", "description": "The project ID", "example": "dev-project-68574", "nullable": true }, "account_id": { "type": "string", "description": "The account ID", "example": "45355976281015164504", "nullable": true }, "success": { "type": "boolean", "description": "The success flag", "example": true, "nullable": true }, "status_code": { "type": "number", "description": "The HTTP status code", "example": 200, "nullable": true }, "connector_key": { "type": "string", "description": "The connector key", "example": "workday", "nullable": true }, "connector_version": { "type": "string", "description": "The connector version", "example": "1.0.0", "nullable": true }, "connector_owner": { "type": "string", "description": "The connector owner", "example": "stackone", "nullable": true }, "connector": { "description": "The connector display data — name, logo and categories. Only present when requested via `?expand=connector`; `connector_key`, `connector_version` and `connector_owner` are always returned regardless.", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/LogConnectorApiModel" } ] }, "mode": { "type": "string", "description": "The mode", "example": "production", "nullable": true }, "http_method": { "type": "string", "description": "The HTTP method", "example": "GET", "nullable": true }, "url": { "type": "string", "description": "The request URL", "example": "https://api.stackone.com/unified/hris/employees", "nullable": true }, "source_type": { "type": "string", "description": "The source type", "example": "DASHBOARD", "nullable": true }, "source_id": { "type": "string", "description": "The source ID", "example": "1234567890", "nullable": true }, "source_value": { "type": "string", "description": "The source value", "example": "ACCOUNT_TESTER", "nullable": true }, "auth_type": { "type": "string", "description": "The authentication type", "example": "API_KEY", "nullable": true }, "auth_id": { "type": "string", "description": "The authentication ID", "example": "auth-123", "nullable": true }, "user_agent": { "type": "string", "description": "The user agent", "example": "Mozilla/5.0", "nullable": true }, "ip_address": { "type": "string", "description": "The IP address", "example": "192.168.1.1", "nullable": true }, "session_id": { "type": "string", "description": "The session ID", "example": "session-123", "nullable": true }, "agent_id": { "type": "string", "description": "The agent ID", "example": "agent-123", "nullable": true }, "transport_type": { "type": "string", "description": "The transport type", "example": "HTTP", "nullable": true }, "stream_type": { "type": "string", "description": "The stream type", "example": "HTTP", "nullable": true }, "is_background": { "type": "boolean", "description": "Whether this is a background request", "example": false, "nullable": true }, "origin_owner_id": { "type": "string", "description": "The origin owner ID", "example": "owner-123", "nullable": true }, "origin_owner_name": { "type": "string", "description": "The origin owner name", "example": "Test Owner", "nullable": true }, "action_run_id": { "type": "string", "description": "The action run ID", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "action_id": { "type": "string", "description": "The action ID", "example": "get_employees", "nullable": true }, "connector_profile_id": { "type": "string", "description": "The connector profile ID", "example": "profile-123", "nullable": true }, "action_type": { "type": "string", "description": "The action type", "example": "sync", "nullable": true }, "category": { "type": "string", "description": "The category", "example": "hris", "nullable": true }, "risk_level": { "type": "string", "description": "The risk level from Defender", "example": "low", "nullable": true }, "tier2_score": { "type": "number", "description": "The tier 2 score from Defender", "example": 0.5, "nullable": true } }, "required": [ "log_id", "log_type", "action_run_id" ] }, "ActionLogsPaginated": { "type": "object", "properties": { "query": { "type": "object", "description": "Pagination metadata", "example": { "page": 1, "page_size": 25 }, "nullable": true }, "total": { "type": "number", "description": "Total number of logs", "example": 100, "nullable": true }, "data": { "description": "The list of action logs", "type": "array", "items": { "$ref": "#/components/schemas/ActionLog" } } }, "required": [ "data" ] }, "ActionLogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActionLogsQueryDto" } ] } } }, "ActionLogsQueryDto": { "type": "object", "properties": { "action_run_id": { "description": "Filter by action run IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "account_secure_id": { "description": "Filter by account IDs", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "action_id": { "description": "Filter by action IDs", "example": [ "get_employees" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_key": { "description": "Filter by connector keys", "example": [ "slack" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "mode": { "description": "Filter by modes", "example": [ "production" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "category": { "description": "Filter by connector categories", "example": [ "hris" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "action_type": { "description": "Filter by action types", "example": [ "sync" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_version": { "description": "Filter by connector versions", "example": [ "1.0.0" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_profile_id": { "description": "Filter by connector profile IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "origin_owner_id": { "description": "Filter by origin owner IDs", "example": [ "owner-123" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "origin_owner_name": { "description": "Filter by origin owner names", "nullable": true, "type": "array", "items": { "type": "string" } }, "http_method": { "type": "array", "description": "Filter by HTTP methods", "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "get", "post", "put", "delete", "patch", null ] } }, "source_type": { "description": "Filter by source types", "example": [ "DASHBOARD" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_id": { "description": "Filter by source IDs", "example": [ "1234567890" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "status_code": { "description": "Filter by HTTP status codes", "example": [ "200" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "ActionMetaItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The action ID", "nullable": true }, "label": { "type": "string", "description": "The action label", "nullable": true }, "description": { "type": "string", "description": "The action description", "nullable": true }, "schema_type": { "type": "string", "description": "The schema type for the action", "nullable": true }, "syncable": { "type": "boolean", "description": "Whether this action can be synced with the datasync v2 sync engine.", "nullable": true }, "supports_incremental": { "type": "boolean", "description": "Whether this action supports incremental syncs (has an incremental strategy).", "nullable": true }, "has_required_parameters": { "type": "boolean", "description": "Whether this action requires parameters to be supplied when it is synced. Such actions cannot be linked automatically for every account — each schedule must be created with its parameter values.", "nullable": true }, "tags": { "description": "The tags associated with this action", "nullable": true, "type": "array", "items": { "type": "string" } }, "authentication": { "description": "The authentication methods supported by this action", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationMetaItem" } }, "action_details": { "type": "object", "description": "The action details for the action", "additionalProperties": true, "nullable": true }, "required_scopes": { "description": "The required scopes for the action", "nullable": true, "type": "array", "items": { "type": "string" } } } }, "ActionSearchDto": { "type": "object", "properties": { "query": { "type": "string", "description": "Search query for finding connector actions", "example": "send a message" }, "connector": { "type": "string", "description": "Filter by connector key, at any version. Shorthand for `connector_versions: { \"\": [\"*\"] }`, which takes priority when both are sent.", "example": "slack" }, "connector_versions": { "type": "object", "description": "Connector versions to search, keyed by connector key. Takes priority over `connector`. At most 100 connector keys and 500 versions in total. `latest` is not accepted — pass resolved versions such as `1.2.0`, or `*` for any version of that connector. `*` cannot be mixed with explicit versions in the same list. Explicit versions are returned as-is; `*` is deduplicated to the highest semver per action, and one map may mix the two forms across connectors.", "example": { "slack": [ "1.2.0", "1.3.1" ], "hubspot": [ "*" ] }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "top_k": { "type": "number", "description": "Number of results to return", "default": 100, "minimum": 1, "maximum": 500 }, "min_similarity": { "type": "number", "description": "Minimum similarity score threshold (0-1). Results below this score are filtered out.", "example": 0.2, "default": 0.2, "minimum": 0, "maximum": 1 } }, "required": [ "query" ] }, "ActionSearchResponseDto": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ActionSearchResultDto" } }, "total_count": { "type": "number", "description": "Total number of results returned" }, "query": { "type": "string", "description": "Original search query" }, "connector_filter": { "type": "string", "description": "Connector filter applied" }, "project_filter": { "type": "string", "description": "Project filter applied" }, "returned_by_connector": { "type": "object", "description": "Per connector key, the number of rows returned in this result window, seeded to 0 for every connector key the caller asked for. This is a window count, not a match count: read 0 as \"not indexed yet\" only when `truncated` is false, since a full window can crowd out a connector that is fully indexed.", "example": { "slack": 7, "hubspot": 0 }, "additionalProperties": { "type": "number" } }, "truncated": { "type": "boolean", "description": "Whether the vector store filled the entire top_k budget, so results were cut off.", "example": false } }, "required": [ "results", "total_count", "query" ] }, "ActionSearchResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Opaque action identifier. Do not parse it: a connector key and an action id may both contain \"_\" and a scope may contain \"/\", so it does not split into fixed parts. Resolve it against the connector registry instead.", "example": "slack_1.0.0_slack_send_message_global" }, "similarity_score": { "type": "number", "description": "Cosine similarity score (0-1)" }, "prerequisite_actions": { "description": "Prerequisite action IDs that should be run first to obtain IDs this action needs", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "similarity_score" ] }, "ActionsMeta": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account ID this metadata applies to (only present when filtering by account_ids)", "nullable": true }, "integration_id": { "type": "string", "description": "Deprecated: use `connector_profile_id` instead. The integration ID this metadata applies to (only present when filtering by account_ids).", "deprecated": true, "nullable": true }, "connector_profile_id": { "type": "string", "description": "The connector profile ID this metadata applies to (only present when filtering by account_ids)", "nullable": true }, "version": { "type": "string", "description": "The version of the actions metadata", "nullable": true }, "name": { "type": "string", "description": "The name of the provider", "nullable": true }, "key": { "type": "string", "description": "The unique key for the provider", "nullable": true }, "icon": { "type": "string", "description": "The icon URL for the provider", "nullable": true }, "description": { "type": "string", "description": "The description of the provider", "nullable": true }, "release_stage": { "type": "string", "description": "The release stage of the connector (e.g., ga, beta, preview). By default, StackOne organizations only have access to connectors in the 'ga' stage. To get access to 'beta' or 'preview' stage connectors, please contact support.", "nullable": true }, "categories": { "description": "The categories associated with this provider (e.g., hris, ats, crm)", "example": [ "hris", "ats" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "authentication": { "description": "The authentication methods supported by the provider", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationMetaItem" } }, "scope_definitions": { "description": "The list of scope definitions available for this provider", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ScopeDefinitionMetaItem" } }, "actions": { "description": "The list of actions available for this provider", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ActionMetaItem" } }, "event_actions": { "description": "The list of events available for this provider", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/EventMetaItem" } } } }, "ActionsMetaPaginated": { "type": "object", "properties": { "next": { "type": "string", "description": "Cursor for fetching the next page of results", "nullable": true }, "data": { "description": "The list of actions metadata", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ActionsMeta" } } } }, "ActionsRpcQueryDto": { "type": "object", "properties": { "debug": { "type": "boolean", "description": "Enable debug mode for the action execution", "example": false, "nullable": true } } }, "ActionsRpcRequestDto": { "type": "object", "properties": { "action": { "type": "string", "description": "The action to execute", "example": "create_employee" }, "path": { "type": "object", "description": "Path parameters for the action", "example": { "id": "123" }, "nullable": true, "additionalProperties": true }, "query": { "description": "Query parameters for the action", "nullable": true, "additionalProperties": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ActionsRpcQueryDto" } ] }, "headers": { "type": "object", "description": "Headers for the action", "example": { "Content-Type": "application/json" }, "nullable": true, "additionalProperties": true }, "body": { "type": "object", "description": "Request body for the action", "example": { "data": "example" }, "nullable": true, "additionalProperties": true }, "defender_enabled": { "type": "boolean", "description": "Override the account-level defender enabled setting for this request. Deprecated: use defender_config instead.", "example": true, "nullable": true, "deprecated": true }, "defender_config": { "description": "Per-request defender configuration. Takes precedence over defender_enabled and project settings.", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/DefenderConfigDto" } ] } }, "required": [ "action" ] }, "ActionsRpcSyncedRequestDto": { "type": "object", "properties": { "action": { "type": "string", "description": "The action to execute", "example": "create_employee" }, "path": { "type": "object", "description": "Accepted for backwards compatibility but ignored on this endpoint: synced reads no longer select the run by path parameters. Use `sync_id` to choose which sync to read.", "example": { "id": "123" }, "nullable": true, "additionalProperties": true, "deprecated": true }, "query": { "type": "object", "description": "Accepted for backwards compatibility but ignored on this endpoint: synced reads no longer select the run by query parameters. Use `sync_id` to choose which sync to read.", "example": { "account_id": "abc" }, "nullable": true, "additionalProperties": true, "deprecated": true }, "body": { "type": "object", "description": "Accepted for backwards compatibility but ignored on this endpoint: synced reads no longer select the run by request body. Use `sync_id` to choose which sync to read.", "example": { "search": "John" }, "nullable": true, "additionalProperties": true, "deprecated": true }, "headers": { "type": "object", "description": "Accepted for backwards compatibility but ignored on this endpoint: synced reads no longer select the run by headers. Use `sync_id` to choose which sync to read.", "example": { "x-custom-header": "value" }, "nullable": true, "additionalProperties": true, "deprecated": true }, "filter": { "type": "object", "description": "OpenSearch-style filter (Query DSL) (term / terms / range / wildcard / match / match_phrase / exists / bool) over synced fields. A filter is one clause: an object with exactly one query type, keyed by field name, e.g. {\"term\": {\"\": }}, {\"terms\": {\"\": [...]}}, {\"range\": {\"\": {\"gte\": ...}}}; combine clauses with {\"bool\": {\"filter\": [...], \"must_not\": [...]}}. Bare {\"\": } maps are rejected. match / match_phrase do word-level search (string fields only, case-insensitive); wildcard matches patterns (case-sensitive). Use field names exactly as returned in the action's \"queryable_fields\".", "example": { "match": { "description": "onboarding" } }, "nullable": true, "additionalProperties": true }, "search": { "type": "string", "description": "Free-text search over the record's text fields, ranked by relevance. Supports \"quoted phrases\", +required / -excluded terms, and prefix* — lenient (never errors). Combine with `filter` to narrow; results are relevance-ranked unless an explicit sort is given.", "example": "onboarding safety", "nullable": true }, "sync_id": { "type": "string", "description": "Which sync to read, when the account has more than one sync of this action. Omit when there is only one. A named sync is never substituted if it is gone. Naming one that no longer exists is rejected with a `400`.", "example": "sch_01J8Z3Q4", "nullable": true }, "source": { "type": "array", "description": "Field names to return (projection) — omit to return all fields. Shrinks the response.", "items": { "type": "string" }, "example": [ "first_name", "email" ], "nullable": true }, "sort": { "type": "array", "description": "OpenSearch-style sort. Each entry is either a field name (ascending) or an object keyed by field name: `{\"last_name\": \"desc\"}`, or the nested form `{\"last_name\": {\"order\": \"desc\"}}`. Earlier entries take priority.", "example": [ { "last_name": "desc" } ], "nullable": true }, "aggs": { "type": "object", "description": "OpenSearch aggregations object. When set, aggregation results are returned instead of records, and `source`, `sort`, `page_size` and `skip` are ignored (`filter` still applies; `page_size` and `skip` must still be within their limits).", "example": { "by_status": { "terms": { "field": "employment_status" } } }, "nullable": true, "additionalProperties": true } }, "required": [ "action" ] }, "ActionsSyncedDatasync": { "type": "object", "properties": { "last_full_run_id": { "type": "string", "description": "Run ID of the last successful full sync — the generation that produced the currently-readable data. Informational." }, "last_run_id": { "type": "string", "description": "Run ID of the most recent run that produced or refreshed data for this scope. Informational." }, "request_id": { "type": "string", "description": "The unique request ID for this sync read" }, "synced_at": { "type": "string", "description": "ISO 8601 timestamp of when the data was synced" }, "sync_expires_at": { "type": "string", "description": "ISO 8601 timestamp of when the synced data expires" }, "params_hash": { "type": "string", "description": "Hash of the canonicalized sync parameters (pagination and undeclared keys stripped)" }, "sync_id": { "type": "string", "description": "Which sync served this read." }, "sync_name": { "type": "string", "description": "The served sync's raw name. Not unique, and may be the bare action id." } }, "required": [ "last_full_run_id", "last_run_id", "request_id", "synced_at", "sync_expires_at", "params_hash", "sync_id", "sync_name" ] }, "ActionsSyncedRefusal": { "type": "object", "properties": { "synced": { "type": "boolean", "description": "Always false: no synced data was returned." }, "action_id": { "type": "string", "description": "The action this refusal is about." }, "message": { "type": "string", "description": "Human-readable explanation of why no data was returned." }, "syncs": { "description": "Present when the account has more than one sync of this action: the sync_id choices — pass one as `sync_id` to disambiguate.", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ActionsSyncedSyncChoice" } } }, "required": [ "synced", "action_id", "message" ] }, "ActionsSyncedResponse": { "type": "object", "properties": { "data": { "type": "array", "description": "The synced records for the requested action", "items": { "type": "object", "additionalProperties": true }, "nullable": true }, "datasync": { "description": "Metadata about the datasync operation", "allOf": [ { "$ref": "#/components/schemas/ActionsSyncedDatasync" } ] }, "aggregations": { "type": "object", "description": "Present instead of `data` when the request set `aggs`: the OpenSearch aggregation results, keyed the same as the requested `aggs`.", "additionalProperties": true, "nullable": true } }, "required": [ "datasync" ] }, "ActionsSyncedSyncChoice": { "type": "object", "properties": { "sync_id": { "type": "string", "description": "Pass this as `sync_id` to select this sync." }, "sync_name": { "type": "string", "description": "The sync's raw name. Not unique, and may be the bare action id." }, "sync_label": { "type": "string", "description": "Disambiguated label: the name, with parameters appended when the name alone does not distinguish this choice from another." } }, "required": [ "sync_id", "sync_name", "sync_label" ] }, "AggregationPostDto": { "type": "object", "properties": { "dimensions": { "type": "array", "description": "The dimensions to group the results by", "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "connector_key", "success", "action_type", "mode", "service", "resource", "action_id", "http_method", "account_secure_id", "source_type", "status_code", "origin_owner_id", "source_id", "auth_type", "auth_id", "is_background", "policy_result", "risk_level", null ] } }, "interval_type": { "type": "string", "description": "The time interval to bucket results by", "enum": [ "minute", "hour", "day", "week", "month", "none", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "interval_period": { "type": "number", "description": "The number of interval units per time bucket", "example": 1, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/LogsQueryDto" } ] } } }, "AuthConfig": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the auth config" }, "name": { "type": "string", "description": "The display name of the auth config" }, "connector_key": { "type": "string", "description": "The connector key (provider identifier)" }, "connector_label": { "type": "string", "description": "The human-readable connector label" }, "connector_version": { "type": "string", "description": "The resolved connector version", "nullable": true }, "connector_pinned_version": { "type": "string", "description": "The pinned connector version, if set", "nullable": true }, "connector_owner": { "type": "string", "description": "The owner of the connector version", "nullable": true }, "logo_url": { "type": "string", "description": "The URL of the connector logo" }, "categories": { "description": "The categories this auth config belongs to", "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Whether the auth config is enabled" }, "default": { "type": "boolean", "description": "Whether this is the default auth config" }, "environment": { "type": "string", "description": "The environment of the auth config", "nullable": true }, "authentication_config_key": { "type": "string", "description": "The authentication configuration key", "nullable": true }, "authentication_config_label": { "type": "string", "description": "The human-readable authentication configuration label", "nullable": true }, "release_stage": { "type": "string", "description": "The release stage of the connector" }, "created_at": { "type": "string", "description": "The timestamp when the auth config was created", "format": "date-time" }, "updated_at": { "type": "string", "description": "The timestamp when the auth config was last updated", "format": "date-time" } }, "required": [ "id", "name", "connector_key", "connector_label", "logo_url", "categories", "active", "default", "release_stage", "created_at", "updated_at" ] }, "AuthConfigsPaginated": { "type": "object", "properties": { "page": { "type": "number", "description": "The current page number" }, "page_size": { "type": "number", "description": "The number of results per page" }, "total": { "type": "number", "description": "The total number of auth configs matching the query" }, "data": { "description": "The list of auth configs", "type": "array", "items": { "$ref": "#/components/schemas/AuthConfig" } } }, "required": [ "page", "page_size", "total", "data" ] }, "AuthenticationGuidesMeta": { "type": "object", "properties": { "config": { "description": "Configuration guide", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/GuideMeta" } ] }, "setup": { "description": "Account linking guide", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/GuideMeta" } ] } } }, "AuthenticationMetaItem": { "type": "object", "properties": { "type": { "type": "string", "description": "The authentication type", "nullable": true }, "label": { "type": "string", "description": "The authentication label", "nullable": true }, "key": { "type": "string", "description": "The authentication key", "nullable": true }, "required_scopes": { "description": "The required scopes for this authentication method", "nullable": true, "type": "array", "items": { "type": "string" } }, "support": { "description": "The support information for this authentication method, including configuration and account linking guides", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/SupportMeta" } ] } } }, "BadGatewayResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 502 }, "message": { "type": "string", "description": "Error message", "example": "Bad Gateway" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "BadRequestResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 400 }, "message": { "type": "string", "description": "Error message", "example": "Bad Request" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" }, "data": { "description": "Error details", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/UnifiedError" } ] }, "provider_errors": { "description": "List of provider-specific errors", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ProviderError" } } }, "required": [ "statusCode", "message", "timestamp" ] }, "CheckPermissionsRequestDto": { "type": "object", "properties": { "user_id": { "type": "string", "description": "User identifier — can be a StackOne composite ID (encoded prefix) or a plain provider user ID (e.g. Slack U08FW4R4N6S). At least one of user_id or email is required.", "example": "U08FW4R4N6S", "nullable": true }, "email": { "type": "string", "description": "User email address. At least one of user_id or email is required.", "example": "user@company.com", "nullable": true }, "resource_id": { "type": "string", "description": "Resource identifier — can be a StackOne composite ID (c28xIQ... prefix) or a plain provider ID", "example": "C08G6QB90LU" }, "resource_type": { "type": "string", "description": "Resource type (e.g. channel, workspace, file). When omitted, connector may infer from resource_id.", "example": "channel", "nullable": true }, "action": { "type": "string", "description": "Permission action to check", "enum": [ "read", "write", "comment", "delete", "export", null ], "example": "read", "nullable": true } }, "required": [ "resource_id" ] }, "CheckPermissionsResponse": { "type": "object", "properties": { "data": { "type": "object", "description": "Permission check result data", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "resource": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" } } }, "action": { "type": "string" }, "allowed": { "type": "boolean" } }, "nullable": true } } }, "ConflictResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 409 }, "message": { "type": "string", "description": "Error message", "example": "Conflict" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "ConnectorProfile": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the connector profile" }, "name": { "type": "string", "description": "The display name of the connector profile" }, "connector_key": { "type": "string", "description": "The connector key (provider identifier)" }, "connector_label": { "type": "string", "description": "The human-readable connector label" }, "connector_version": { "type": "string", "description": "The resolved connector version", "nullable": true }, "connector_pinned_version": { "type": "string", "description": "The pinned connector version, if set", "nullable": true }, "connector_owner": { "type": "string", "description": "The owner of the connector version", "nullable": true }, "logo_url": { "type": "string", "description": "The URL of the connector logo" }, "categories": { "description": "The categories this connector profile belongs to", "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Whether the connector profile is enabled" }, "default": { "type": "boolean", "description": "Whether this is the default connector profile" }, "environment": { "type": "string", "description": "The environment of the connector profile", "nullable": true }, "authentication_config_key": { "type": "string", "description": "The authentication configuration key", "nullable": true }, "authentication_config_label": { "type": "string", "description": "The human-readable authentication configuration label", "nullable": true }, "release_stage": { "type": "string", "description": "The release stage of the connector" }, "created_at": { "type": "string", "description": "The timestamp when the connector profile was created", "format": "date-time" }, "updated_at": { "type": "string", "description": "The timestamp when the connector profile was last updated", "format": "date-time" } }, "required": [ "id", "name", "connector_key", "connector_label", "logo_url", "categories", "active", "default", "release_stage", "created_at", "updated_at" ] }, "ConnectorProfilePinnedVersion": { "type": "object", "properties": { "connector_profile_id": { "type": "string", "description": "The id of the connector profile this pinned version belongs to" }, "pinned_version": { "type": "string", "description": "The pinned connector version" }, "owner": { "type": "string", "description": "The owner of the pinned connector version", "nullable": true }, "created_at": { "type": "string", "description": "The timestamp when the pinned version was created", "format": "date-time" }, "updated_at": { "type": "string", "description": "The timestamp when the pinned version was last updated", "format": "date-time" } }, "required": [ "connector_profile_id", "pinned_version", "created_at", "updated_at" ] }, "ConnectorProfilesPaginated": { "type": "object", "properties": { "page": { "type": "number", "description": "The current page number" }, "page_size": { "type": "number", "description": "The number of results per page" }, "total": { "type": "number", "description": "The total number of connector profiles matching the query" }, "data": { "description": "The list of connector profiles", "type": "array", "items": { "$ref": "#/components/schemas/ConnectorProfile" } } }, "required": [ "page", "page_size", "total", "data" ] }, "ConnectorProfileVersion": { "type": "object", "properties": { "version": { "type": "string", "description": "The connector version" }, "pinned": { "type": "boolean", "description": "Whether this version is the one currently pinned for the connector profile" }, "builtin": { "type": "boolean", "description": "Whether this version is a built-in StackOne connector (true) or a custom one (false)" }, "owner": { "type": "string", "description": "The owner of this connector version. \"stackone\" for built-in connectors." } }, "required": [ "version", "pinned", "builtin", "owner" ] }, "ConnectorsMeta": { "type": "object", "properties": { "provider": { "type": "string", "example": "hibob", "description": "The provider key" }, "provider_name": { "type": "string", "example": "Hibob", "description": "The provider human-readable label" }, "category": { "type": "string", "enum": [ "ats", "hris", "hris-legacy", "crm", "iam", "marketing", "lms", "stackone", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ], "example": "hris", "description": "The provider service category", "x-speakeasy-unknown-values": "allow" }, "active": { "type": "boolean", "example": true, "description": "Whether this provider has been enabled on the integrations page for the current project", "nullable": true }, "models": { "type": "object", "additionalProperties": true, "example": { "employees": { "create": { "apiPath": "/unified/hris/employees/:id", "input": { "defaultFields": [ { "name": "first_name", "type": "string" } ] }, "output": { "defaultFields": [ { "name": "id", "type": "string" } ] } } }, "time_off": { "get": { "apiPath": "/unified/hris/employees/:id/time_off/:id", "output": { "defaultFields": [ { "name": "id", "type": "string" } ] } } } } }, "resources": { "description": "Resources for this provider, such as image assets", "example": { "images": { "logo_url": "https://app.stackone.com/assets/logos/hibob.png", "original_logo_horizontal_url": "https://app.stackone.com/assets/logos/original/hibob_horizontal.png" } }, "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorsMetaResources" } ] } }, "required": [ "provider", "provider_name", "category", "models" ] }, "ConnectorsMetaResources": { "type": "object", "properties": { "images": { "description": "Image assets for this provider", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorsMetaResourcesImagesApiModel" } ] } } }, "ConnectorsMetaResourcesImagesApiModel": { "type": "object", "properties": { "logo_url": { "type": "string", "example": "https://app.stackone.com/assets/logos/hibob.png", "description": "URL of the square logo designed and used by StackOne for this provider", "nullable": true }, "original_logo_horizontal_url": { "type": "string", "example": "https://app.stackone.com/assets/logos/source/hibob.png", "description": "URL of the original provider logo (with logo and/or name aligned horizontally)", "nullable": true } } }, "ConnectSession": { "type": "object", "properties": { "id": { "type": "number" }, "organization_id": { "type": "string" }, "project_id": { "type": "string" }, "categories": { "type": "array", "example": [ "ats", "hris", "hrisLegacy", "crm", "iam", "marketing", "lms", "stackOne", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ], "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "ats", "hris", "hris-legacy", "crm", "iam", "marketing", "lms", "stackone", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling", null ] } }, "provider": { "type": "string", "nullable": true }, "origin_owner_id": { "type": "string" }, "origin_owner_name": { "type": "string" }, "origin_username": { "type": "string", "nullable": true }, "account_id": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "metadata": { "type": "object", "description": "Arbitrary set of key and values defined during the session token creation. This can be used to tag an account (eg. based on their pricing plan)", "nullable": true }, "external_trigger_token": { "type": "string", "description": "External trigger token to be used to trigger actions on the account", "example": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "nullable": true }, "type": { "type": "string", "description": "The connect session account type", "enum": [ "production", "test", "unmapped_value", null ], "example": [ "PRODUCTION", "TEST" ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "integration_id": { "type": "string", "description": "Deprecated: use `connector_profile_id` instead. The integration ID (UUID) associated with this connect session.", "deprecated": true, "nullable": true }, "connector_profile_id": { "type": "string", "description": "The connector profile ID associated with this connect session", "nullable": true }, "latest_connection_attempt": { "nullable": true, "description": "The most recent connection attempt initiated against this session, if any. Use this to poll for OAuth completion: when status is \"authenticated\", the resulting account is at account_secure_id.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectSessionLatestAttempt" } ] } }, "required": [ "id", "organization_id", "project_id", "origin_owner_id", "origin_owner_name", "created_at" ] }, "ConnectSessionAuthenticate": { "type": "object", "properties": { "token": { "type": "string", "description": "The token to authenticate with" } }, "required": [ "token" ] }, "ConnectSessionCreate": { "type": "object", "properties": { "categories": { "type": "array", "description": "The categories of the provider to connect to", "example": [ "ats", "hris", "hrisLegacy", "crm", "iam", "marketing", "lms", "stackOne", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ], "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "ats", "hris", "hris-legacy", "crm", "iam", "marketing", "lms", "stackone", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling", null ] } }, "provider": { "type": "string", "description": "The provider key to connect to (e.g. \"salesforce\", \"bamboohr\"). When provided, the hub opens directly at the credential entry step for this provider. The session binds to the project default connector profile when the caller may use it, otherwise to another connector profile for the provider that the caller may use; if none is usable the request is refused. Omit to show the full provider selection screen. To target a specific connector profile, use connector_profile_id instead.", "nullable": true }, "provider_version": { "type": "string", "deprecated": true, "description": "Deprecated. When supplied, provider_version restricts binding to connector profiles of that version, so a version with no usable profile causes session creation to fail. Omit it to bind the default connector profile (or another the caller may use). To target a specific connector profile, use connector_profile_id.", "nullable": true }, "origin_owner_id": { "type": "string", "description": "The unique identifier for the organization in your system (e.g. your customer's org ID). Combined with origin_owner_name and provider, this determines whether a new linked account is created or an existing one is updated." }, "origin_owner_name": { "type": "string", "description": "A human-readable name for the organization. Stored against the linked account in StackOne for identification purposes." }, "origin_username": { "type": "string", "description": "The origin username", "nullable": true }, "account_id": { "type": "string", "description": "The unique identifier for the account associated with this connect session. When this field is present, the hub will launch in edit mode using the retrieved token.", "nullable": true }, "expires_in": { "type": "number", "description": "How long the session should be valid for in seconds", "default": 1800, "nullable": true }, "metadata": { "type": "object", "description": "The metadata for the connection", "nullable": true }, "multiple": { "type": "boolean", "description": "If set, this connect session will allow creation of multiple accounts with the same origin owner id and provider. Has no effect if account_id is set.", "default": false, "nullable": true }, "label": { "type": "string", "description": "The label to be applied to the account associated with this connect session.", "nullable": true }, "type": { "type": "string", "description": "The connect session account type", "enum": [ "production", "test", null ], "example": [ "PRODUCTION", "TEST" ], "default": "production", "x-speakeasy-unknown-values": "allow", "nullable": true }, "integration_id": { "type": "string", "description": "Deprecated: use `connector_profile_id` instead (this is an alias for it). The ID of the connector profile to use for this connect session. Use this to route to a non-default connector profile — for example when you have multiple profiles for the same provider, or when migrating end users to a new connector major version. Retrieve the ID from GET /connector_profiles. When omitted, the session binds to the project default connector profile when the caller may use it, otherwise to another connector profile for the provider that the caller may use.", "deprecated": true, "nullable": true }, "connector_profile_id": { "type": "string", "description": "The ID of the connector profile to use for this connect session. Use this to route to a non-default connector profile — for example when you have multiple profiles for the same provider, or when migrating end users to a new connector major version. Retrieve the ID from GET /connector_profiles. When omitted, the session binds to the project default connector profile when the caller may use it, otherwise to another connector profile for the provider that the caller may use.", "nullable": true } }, "required": [ "origin_owner_id", "origin_owner_name" ] }, "ConnectSessionLatestAttempt": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "authenticated", "error", "cancelled", null ], "example": "pending", "x-speakeasy-unknown-values": "allow", "nullable": true }, "account_secure_id": { "type": "string", "nullable": true, "description": "The secure id of the account created/updated by this attempt. Populated only after a successful authentication." }, "oauth_error_code": { "type": "string", "nullable": true }, "oauth_error_description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "created_at", "updated_at" ] }, "ConnectSessionTokenAuthLink": { "type": "object", "properties": { "id": { "type": "number" }, "organization_id": { "type": "string" }, "project_id": { "type": "string" }, "categories": { "type": "array", "example": [ "ats", "hris", "hrisLegacy", "crm", "iam", "marketing", "lms", "stackOne", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ], "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "ats", "hris", "hris-legacy", "crm", "iam", "marketing", "lms", "stackone", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling", null ] } }, "provider": { "type": "string", "nullable": true }, "origin_owner_id": { "type": "string" }, "origin_owner_name": { "type": "string" }, "origin_username": { "type": "string", "nullable": true }, "account_id": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "metadata": { "type": "object", "description": "Arbitrary set of key and values defined during the session token creation. This can be used to tag an account (eg. based on their pricing plan)", "nullable": true }, "external_trigger_token": { "type": "string", "description": "External trigger token to be used to trigger actions on the account", "example": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "nullable": true }, "type": { "type": "string", "description": "The connect session account type", "enum": [ "production", "test", "unmapped_value", null ], "example": [ "PRODUCTION", "TEST" ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "integration_id": { "type": "string", "description": "Deprecated: use `connector_profile_id` instead. The integration ID (UUID) associated with this connect session.", "deprecated": true, "nullable": true }, "connector_profile_id": { "type": "string", "description": "The connector profile ID associated with this connect session", "nullable": true }, "latest_connection_attempt": { "nullable": true, "description": "The most recent connection attempt initiated against this session, if any. Use this to poll for OAuth completion: when status is \"authenticated\", the resulting account is at account_secure_id.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectSessionLatestAttempt" } ] }, "token": { "type": "string" }, "auth_link_url": { "type": "string" } }, "required": [ "id", "organization_id", "project_id", "origin_owner_id", "origin_owner_name", "created_at", "token", "auth_link_url" ] }, "DefenderConfigDto": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to run defender at all", "example": true, "nullable": true }, "block_high_risk": { "type": "boolean", "description": "Whether to block tool execution when a HIGH risk score is detected", "example": false, "nullable": true }, "use_tier1_classification": { "type": "boolean", "description": "Whether to run tier 1 pattern-based detection", "example": true, "nullable": true }, "use_tier2_classification": { "type": "boolean", "description": "Whether to run tier 2 ML-based detection", "example": true, "nullable": true } } }, "DimensionsPostDto": { "type": "object", "properties": { "dimensions": { "type": "array", "description": "The dimensions to return distinct values for", "x-speakeasy-unknown-values": "allow", "items": { "type": "string", "enum": [ "connector_key", "success", "action_type", "mode", "service", "resource", "action_id", "http_method", "account_secure_id", "source_type", "status_code", "origin_owner_id", "source_id", "auth_type", "auth_id", "is_background", "policy_result", "risk_level" ] } }, "max_values": { "type": "number", "description": "The maximum number of distinct values to return per dimension", "minimum": 1, "maximum": 1000, "default": 100, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/LogsQueryDto" } ] } }, "required": [ "dimensions" ] }, "EventMetaItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The event ID", "nullable": true }, "label": { "type": "string", "description": "The event label", "nullable": true }, "description": { "type": "string", "description": "The event description", "nullable": true }, "tags": { "description": "The tags associated with this event", "nullable": true, "type": "array", "items": { "type": "string" } }, "release_stage": { "type": "string", "description": "The release stage of the event (e.g., ga, beta, preview)", "nullable": true }, "requires_manual_setup": { "type": "boolean", "description": "Whether the event requires manual setup", "nullable": true }, "authentication": { "description": "The authentication methods supported by this event", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationMetaItem" } } } }, "ForbiddenResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 403 }, "message": { "type": "string", "description": "Error message", "example": "Forbidden resource" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "GuideImageMeta": { "type": "object", "properties": { "src": { "type": "string", "description": "The image source URL or relative path" }, "alt": { "type": "string", "description": "The image alt text" } }, "required": [ "src", "alt" ] }, "GuideMeta": { "type": "object", "properties": { "warning": { "type": "string", "description": "Warning text for the guide", "nullable": true }, "sections": { "description": "The guide sections", "type": "array", "items": { "$ref": "#/components/schemas/GuideSectionMeta" } } }, "required": [ "sections" ] }, "GuideSectionMeta": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the section" }, "content": { "type": "string", "description": "The content of the section, includes markdown formatting" }, "list": { "description": "List items for the section", "nullable": true, "type": "array", "items": { "type": "string" } }, "steps": { "description": "Nested steps within the section", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/GuideStepMeta" } }, "applicableScopes": { "description": "The scopes for which this section is applicable", "nullable": true, "type": "array", "items": { "type": "string" } }, "image": { "description": "An image for the section", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/GuideImageMeta" } ] } }, "required": [ "title", "content" ] }, "GuideStepMeta": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the step" }, "content": { "type": "string", "description": "The content of the step, includes markdown formatting" }, "list": { "description": "List items for the step", "nullable": true, "type": "array", "items": { "type": "string" } }, "displayScopes": { "type": "boolean", "description": "When true, the step should display scopes", "nullable": true }, "applicableScopes": { "description": "The scopes for which this step is applicable", "nullable": true, "type": "array", "items": { "type": "string" } }, "image": { "description": "An image for the step", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/GuideImageMeta" } ] } }, "required": [ "title", "content" ] }, "InternalServerErrorResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 500 }, "message": { "type": "string", "description": "Error message", "example": "Internal server error" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "JsonRpcMessageDto": { "type": "object", "properties": { "jsonrpc": { "type": "string", "example": "2.0", "description": "JSON-RPC protocol version" }, "method": { "type": "string", "example": "initialize", "description": "JSON-RPC method name. Supported values: initialize, tools/list, tools/call." }, "params": { "type": "object", "description": "Method parameters. Shape varies by method — see the request body examples.", "nullable": true }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ], "nullable": true, "description": "Request id (string or number). Echoed back in the response." } }, "required": [ "jsonrpc", "method" ] }, "LinkedAccount": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "provider_name": { "type": "string", "nullable": true }, "categories": { "description": "The categories this provider belongs to (e.g., hris, ats, crm)", "example": [ "hris", "ats" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive", "suspended", "archived", "expired", "error" ], "x-speakeasy-unknown-values": "allow" }, "status_reasons": { "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/StatusReason" } }, "origin_owner_id": { "type": "string" }, "origin_owner_name": { "type": "string" }, "origin_username": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true }, "setup_information": { "type": "object", "additionalProperties": true, "nullable": true }, "label": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "type": { "type": "string", "description": "The account type", "enum": [ "production", "test", "unmapped_value", null ], "example": [ "PRODUCTION", "TEST" ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "shared": { "type": "boolean", "nullable": true } }, "required": [ "id", "provider", "status", "origin_owner_id", "origin_owner_name", "created_at", "updated_at" ] }, "LinkedAccountMeta": { "type": "object", "properties": { "provider": { "type": "string" }, "category": { "type": "string", "enum": [ "ats", "hris", "hris-legacy", "crm", "iam", "marketing", "lms", "stackone", "documents", "ticketing", "screening", "messaging", "accounting", "scheduling" ], "x-speakeasy-unknown-values": "allow" }, "models": { "type": "object", "additionalProperties": true } }, "required": [ "provider", "category", "models" ] }, "LinkedAccountsPaginated": { "type": "object", "properties": { "page": { "type": "number", "description": "The current page number." }, "page_size": { "type": "number", "description": "The number of accounts per page." }, "total": { "type": "number", "description": "The total number of accounts matching the request." }, "data": { "description": "The accounts on this page.", "type": "array", "items": { "$ref": "#/components/schemas/LinkedAccount" } } }, "required": [ "page", "page_size", "total", "data" ] }, "LogConnectorApiModel": { "type": "object", "properties": { "key": { "type": "string", "description": "The connector key", "example": "workday" }, "name": { "type": "string", "description": "The connector display name. `null` when the connector is unknown.", "example": "Workday", "nullable": true }, "logo_url": { "type": "string", "description": "The connector logo. Falls back to a placeholder when none is declared.", "example": "https://app.stackone.com/logos/workday.png" }, "categories": { "description": "The connector categories", "example": [ "hris" ], "type": "array", "items": { "type": "string" } }, "version": { "type": "string", "description": "The connector version the log was served by", "example": "1.0.0", "nullable": true }, "owner": { "type": "string", "description": "The connector owner. Defaults to the global `stackone` owner.", "example": "stackone" } }, "required": [ "key", "name", "logo_url", "categories", "version", "owner" ] }, "LogsDimensions": { "type": "object", "properties": { "data": { "type": "object", "description": "The distinct values for each requested dimension, keyed by dimension name", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LogsDimensionValue" } }, "example": { "connector_key": [ { "value": "workday", "count": 800, "label": "Workday" } ], "success": [ { "value": "true", "count": 1500 } ] } } }, "required": [ "data" ] }, "LogsDimensionValue": { "type": "object", "properties": { "value": { "type": "string", "description": "The dimension value", "example": "workday" }, "count": { "type": "number", "description": "The number of logs carrying this value", "example": 800 }, "label": { "type": "string", "description": "A human-readable label for the value. Currently only resolved for the `connector_key` dimension, where it is the connector display name (falling back to the key itself when the connector is unknown). Absent for every other dimension.", "example": "Workday", "nullable": true } }, "required": [ "value", "count" ] }, "LogsPaginated": { "type": "object", "properties": { "query": { "type": "object", "description": "Pagination metadata", "example": { "page": 1, "page_size": 25 }, "nullable": true }, "total": { "type": "number", "description": "Total number of logs", "example": 100, "nullable": true }, "data": { "type": "array", "description": "The list of logs (ActionLog or UnifiedLog)", "items": { "oneOf": [ { "$ref": "#/components/schemas/ActionLog" }, { "$ref": "#/components/schemas/UnifiedLog" } ], "discriminator": { "propertyName": "log_type", "mapping": { "action": "#/components/schemas/ActionLog", "unified": "#/components/schemas/UnifiedLog" } } } } }, "required": [ "data" ] }, "LogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/LogsQueryDto" } ] } } }, "LogsQueryDto": { "type": "object", "properties": { "action_run_id": { "description": "Filter by action run IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "action_id": { "description": "Filter by action IDs", "example": [ "get_employees" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "action_type": { "description": "Filter by action types", "example": [ "sync" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_key": { "description": "Filter by connector keys", "example": [ "slack" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_version": { "description": "Filter by connector versions", "example": [ "1.0.0" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_owner": { "description": "Filter by connector owners", "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_profile_id": { "description": "Filter by connector profile IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "category": { "description": "Filter by connector categories", "example": [ "hris" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "request_id": { "description": "Filter by request IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "provider": { "description": "Filter by providers", "example": [ "hibob" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "service": { "description": "Filter by services", "example": [ "hris" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "resource": { "description": "Filter by resources", "example": [ "employees" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "sub_resource": { "description": "Filter by sub-resources", "example": [ "documents" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "child_resource": { "description": "Filter by child resources", "nullable": true, "type": "array", "items": { "type": "string" } }, "action": { "description": "Filter by actions", "example": [ "create_employee" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "log_id": { "description": "Filter by log IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "account_secure_id": { "description": "Filter by account IDs", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_id": { "description": "Filter by source IDs", "example": [ "1234567890" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_type": { "description": "Filter by source types", "example": [ "DASHBOARD" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_value": { "description": "Filter by source values", "nullable": true, "type": "array", "items": { "type": "string" } }, "mode": { "description": "Filter by modes", "example": [ "production" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "origin_owner_id": { "description": "Filter by origin owner IDs", "example": [ "owner-123" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "origin_owner_name": { "description": "Filter by origin owner names", "nullable": true, "type": "array", "items": { "type": "string" } }, "auth_type": { "description": "Filter by authentication types", "nullable": true, "type": "array", "items": { "type": "string" } }, "auth_id": { "description": "Filter by authentication IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "user_agent": { "description": "Filter by user agents", "nullable": true, "type": "array", "items": { "type": "string" } }, "ip_address": { "description": "Filter by IP addresses", "nullable": true, "type": "array", "items": { "type": "string" } }, "session_id": { "description": "Filter by session IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "agent_id": { "description": "Filter by agent IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "transport_type": { "description": "Filter by transport types", "nullable": true, "type": "array", "items": { "type": "string" } }, "stream_type": { "description": "Filter by stream types", "nullable": true, "type": "array", "items": { "type": "string" } }, "status_code": { "description": "Filter by HTTP status codes", "example": [ "200" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "is_background": { "type": "boolean", "description": "Filter by whether the request ran in the background", "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "http_method": { "type": "array", "description": "Filter by HTTP methods", "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "get", "post", "put", "delete", "patch", null ] } }, "log_type": { "type": "array", "description": "Filter by log types", "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "action", "unified", null ] } }, "tuples": { "description": "Grouped filters as JSON tuples of dimension and value pairs", "nullable": true, "type": "array", "items": { "type": "string" } }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "NotFoundResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 404 }, "message": { "type": "string", "description": "Error message", "example": "Not Found" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "NotImplementedResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 501 }, "message": { "type": "string", "description": "Error message", "example": "Not Implemented" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "PatchAccountExternalDto": { "type": "object", "properties": { "provider": { "type": "string", "nullable": true }, "origin_owner_id": { "type": "string", "nullable": true }, "origin_owner_name": { "type": "string", "nullable": true }, "origin_username": { "type": "string", "nullable": true }, "credentials": { "type": "object", "additionalProperties": false, "nullable": true }, "setup_information": { "type": "object", "additionalProperties": false, "nullable": true }, "secrets": { "type": "object", "additionalProperties": false, "nullable": true }, "authentication_config_key": { "type": "string", "nullable": true }, "environment": { "type": "string", "nullable": true }, "label": { "type": "object", "nullable": true }, "metadata": { "type": "object", "additionalProperties": false, "nullable": true }, "type": { "type": "string", "description": "The account type", "enum": [ "production", "test", null ], "example": [ "PRODUCTION", "TEST" ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "integration_id": { "type": "string", "description": "Deprecated: use `connector_profile_id` instead.", "deprecated": true, "nullable": true }, "connector_profile_id": { "type": "string", "description": "The ID of the connector profile to associate the account with.", "nullable": true }, "shared": { "type": "boolean", "nullable": true } } }, "PlatformDimensionsPostDto": { "type": "object", "properties": { "dimensions": { "type": "array", "description": "The dimensions to return distinct values for", "x-speakeasy-unknown-values": "allow", "items": { "type": "string", "enum": [ "event_type", "action", "resource", "service", "source_type", "source_id", "auth_type", "user_email", "status_code", "success", "is_read", "agent_id", "transport_type", "stream_type" ] } }, "max_values": { "type": "number", "description": "The maximum number of distinct values to return per dimension", "minimum": 1, "maximum": 1000, "default": 100, "nullable": true }, "filters": { "description": "The filters to apply before collecting the distinct values", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformLogsQueryDto" } ] } }, "required": [ "dimensions" ] }, "PlatformLog": { "type": "object", "properties": { "log_id": { "type": "string", "description": "The unique log identifier", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "log_type": { "type": "string", "description": "The type of log", "enum": [ "platform" ], "example": "platform", "x-speakeasy-unknown-values": "allow" }, "event_time": { "type": "string", "description": "The event ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "start_time": { "type": "string", "description": "The request start time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "description": "The request end time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "duration_ms": { "type": "number", "description": "The duration in milliseconds", "example": 356, "nullable": true }, "project_id": { "type": "string", "description": "The project ID", "example": "dev-project-68574", "nullable": true }, "success": { "type": "boolean", "description": "The success flag", "example": true, "nullable": true }, "status_code": { "type": "number", "description": "The HTTP status, where the event came from a request", "example": 200, "nullable": true }, "source_type": { "type": "string", "description": "The source type", "example": "DASHBOARD", "nullable": true }, "source_id": { "type": "string", "description": "The source ID", "example": "1234567890", "nullable": true }, "auth_type": { "type": "string", "description": "The authentication type", "example": "API_KEY", "nullable": true }, "auth_id": { "type": "string", "description": "The authentication ID", "example": "auth-123", "nullable": true }, "user_agent": { "type": "string", "description": "The user agent", "example": "Mozilla/5.0", "nullable": true }, "ip_address": { "type": "string", "description": "The IP address", "example": "192.168.1.1", "nullable": true }, "session_id": { "type": "string", "description": "The session ID", "example": "session-123", "nullable": true }, "agent_id": { "type": "string", "description": "The agent ID", "example": "agent-123", "nullable": true }, "transport_type": { "type": "string", "description": "The transport type", "example": "HTTP", "nullable": true }, "stream_type": { "type": "string", "description": "The stream type", "example": "HTTP", "nullable": true }, "event_id": { "type": "string", "description": "The unique identifier for this event", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "event_type": { "type": "string", "description": "What happened, as `_`", "example": "account_create" }, "service": { "type": "string", "description": "The service that emitted the event", "example": "unified-api" }, "action": { "type": "string", "description": "The verb, without its resource prefix", "example": "create", "nullable": true }, "resource": { "type": "string", "description": "What was acted on, without the verb", "example": "account", "nullable": true }, "resource_id": { "type": "string", "description": "The id of the thing acted on — an account id, a webhook id", "example": "45355976281015164504", "nullable": true }, "user_id": { "type": "string", "description": "The user the operation is attributed to. Always an identity the credential actually authenticated — a dashboard user session, the signature-covered user id on internal calls, or the verified owner of an IDP user api key. Absent for project api keys and minted session tokens, which carry no dashboard-user identity.", "nullable": true }, "user_email": { "type": "string", "description": "The actor's email, as authenticated by the IDP — for a dashboard user session, for a signed internal call whose forwarded session resolved an authorization context naming the same user the signature did, or for an IDP user api key whose verification returned its owner's email. Absent for project api keys, and for signed internal calls without that context, which carry a user id alone. On an event with no resolved user at all — a failed sign-in, which has neither a user id nor an organization — it is the only thing identifying who acted.", "example": "person@example.com", "nullable": true }, "is_read": { "type": "boolean", "description": "Whether the operation only read state. `false` covers everything that changed something or had a side effect.", "example": false, "nullable": true }, "details": { "type": "object", "description": "Everything about the event with no column of its own — the HTTP method, path and originating request id, the actor's display name (`user_name`, where a guard authenticated one), plus whatever describes the thing acted on. An account write records its id and label, the tenant it connects to (`owner_id`, `account_name`, `owner_username`), the connector key, the connector's display name (`connector_name`), the resolved connector version, and the connector's owner (`connector_owner` — an identifier, `stackone` for a built-in connector, absent where none resolves); reads carry a smaller set. Its shape varies by the service that emitted the event and by the event type, so treat it as display detail rather than a contract. Not filterable; use the columns for that.", "additionalProperties": true, "nullable": true } }, "required": [ "log_id", "log_type", "event_id", "event_type", "service" ] }, "PlatformLogsPaginated": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number returned", "example": 1 }, "page_size": { "type": "number", "description": "The number of results per page", "example": 25 }, "total": { "type": "number", "description": "Total number of logs matching the filters", "example": 100 }, "data": { "description": "The list of platform logs", "type": "array", "items": { "$ref": "#/components/schemas/PlatformLog" } } }, "required": [ "page", "page_size", "total", "data" ] }, "PlatformLogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/PlatformLogsQueryDto" } ] } } }, "PlatformLogsQueryDto": { "type": "object", "properties": { "event_type": { "description": "Filter by event types. Each is `_`, so pass the set for a resource to see everything that happened to it.", "example": [ "account_create", "account_delete" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "event_id": { "description": "Filter by event IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "action": { "description": "Filter by the verb, independent of the resource it acted on", "example": [ "create", "delete" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "resource": { "description": "Filter by what was acted on, independent of the verb", "example": [ "account", "webhook" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "resource_id": { "description": "Filter by the id of the thing acted on — everything that happened to one account, one webhook", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "status_code": { "description": "Filter by HTTP status, where the event came from a request. Each value must be a whole number; a non-numeric one is rejected rather than matching nothing.", "example": [ "200", "404" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "user_id": { "description": "Filter by the user the operation is attributed to", "nullable": true, "type": "array", "items": { "type": "string" } }, "user_email": { "description": "Filter by the actor's email. Recorded when the request carried a dashboard user session, whose identity the IDP authenticated; absent for api keys and for signed internal calls, which carry a user id alone. On an event with no resolved user at all — a failed sign-in, which has neither a user id nor an organization — it is the only thing identifying who acted.", "example": [ "person@example.com" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_type": { "description": "Filter by source type", "nullable": true, "type": "array", "items": { "type": "string" } }, "source_id": { "description": "Filter by source ID", "nullable": true, "type": "array", "items": { "type": "string" } }, "auth_type": { "description": "Filter by the credential type the caller authenticated with", "nullable": true, "type": "array", "items": { "type": "string" } }, "auth_id": { "description": "Filter by the identifier of the credential used", "nullable": true, "type": "array", "items": { "type": "string" } }, "session_id": { "description": "Filter by session ID", "nullable": true, "type": "array", "items": { "type": "string" } }, "agent_id": { "description": "Filter by agent ID", "nullable": true, "type": "array", "items": { "type": "string" } }, "transport_type": { "description": "Filter by transport type", "nullable": true, "type": "array", "items": { "type": "string" } }, "ip_address": { "description": "Filter by the IP the operation came from", "nullable": true, "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "is_read": { "type": "boolean", "description": "Filter by whether the operation only read state. `false` returns the changes — creates, updates, deletes and anything with a side effect.", "example": false, "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "PolicyLog": { "type": "object", "properties": { "result": { "type": "string", "description": "The outcome recorded for the call. `partial` means the call was permitted but a rule removed fields from the response; `monitored` means the call ran unchanged but a monitor-mode rule would have refused it, or would have removed fields from it (see `observed` and `observed_fields`); `error` means the layer could not decide and failed safe.", "example": "partial", "enum": [ "skipped", "allowed", "partial", "monitored", "denied", "error" ], "x-speakeasy-unknown-values": "allow" }, "action_run_id": { "type": "string", "description": "The action run the decision belongs to" }, "action_id": { "type": "string", "description": "The action that was invoked", "example": "linear_list_issues" }, "account_secure_id": { "type": "string", "description": "The account the call ran against" }, "decided_at": { "type": "string", "description": "When the decision was taken, ISO 8601", "example": "2026-09-14T08:30:00.000Z" }, "policy_ids": { "type": "array", "description": "The rules that determined the outcome. Empty unless something refused.", "items": { "type": "string" } }, "principal": { "type": "object", "description": "Who was decided about, and the groups they were in at the time. Recorded because membership changes, so a denial attributed to a group is otherwise unreconstructable.", "additionalProperties": true, "nullable": true }, "level": { "type": "string", "description": "Which narrowing level decided. Absent when nothing was evaluated.", "example": "project", "nullable": true }, "policies": { "type": "array", "description": "Every rule that was in force on this call, whether or not it did anything, and the only place a rule’s name and version are kept. Ordered as the levels were asked, most authoritative first; a rule appears once even where it sits in more than one level’s set. Absent when nothing was evaluated.", "items": { "$ref": "#/components/schemas/PolicyLogPolicy" }, "nullable": true }, "masked_fields": { "type": "array", "description": "The fields removed from the response, present when `result` is `partial`, or `error` when the read side could not be completed and withheld what it could not check", "items": { "$ref": "#/components/schemas/PolicyLogMaskedField" }, "nullable": true }, "observed_fields": { "type": "array", "description": "Fields a monitor-mode rule would have removed, which the caller nonetheless received. The output of a monitored `readField` rollout, kept apart from `masked_fields` so what would have happened is never read as what did. A field an enforcing rule actually removed appears only in `masked_fields`.", "items": { "$ref": "#/components/schemas/PolicyLogObservedField" }, "nullable": true }, "observed": { "type": "array", "description": "Rules that would have refused had their level been enforcing", "items": { "$ref": "#/components/schemas/PolicyLogObservation" }, "nullable": true }, "resolved": { "type": "array", "description": "What every level answered, allows included", "items": { "$ref": "#/components/schemas/PolicyLogResolution" }, "nullable": true } }, "required": [ "result", "action_run_id", "action_id", "account_secure_id", "decided_at", "policy_ids" ] }, "PolicyLogMaskedField": { "type": "object", "properties": { "path": { "type": "string", "description": "The path the rule matched on, as the connector shapes it, with array positions collapsed to `[]` so one entry covers every element of a list", "example": "data.current.temperature_2m" }, "policy_ids": { "type": "array", "description": "The rules that refused this field", "items": { "type": "string" }, "example": [ "33f2e9bd-254c-483e-ba4a-ae6a1a597727" ] }, "level": { "type": "string", "description": "Which narrowing level refused it. Absent when the level was not recorded.", "example": "project", "nullable": true } }, "required": [ "path", "policy_ids" ] }, "PolicyLogObservation": { "type": "object", "properties": { "level": { "type": "string", "description": "The level that observed", "example": "project" }, "decision": { "type": "string", "description": "What it would have answered", "example": "deny" }, "policy_ids": { "type": "array", "description": "The rules behind the observation", "items": { "type": "string" }, "example": [ "21cfc501-43b4-4fdb-bea9-1e79bc1f2425" ] } }, "required": [ "level", "decision", "policy_ids" ] }, "PolicyLogObservedField": { "type": "object", "properties": { "path": { "type": "string", "description": "The path the rule matched on, as the connector shapes it, with array positions collapsed to `[]` so one entry covers every element of a list", "example": "data.worker.salary" }, "policy_ids": { "type": "array", "description": "The monitor-mode rules that would have removed this field", "items": { "type": "string" }, "example": [ "21cfc501-43b4-4fdb-bea9-1e79bc1f2425" ] }, "level": { "type": "string", "description": "Which narrowing level observed it. Absent when the level was not recorded.", "example": "org", "nullable": true } }, "required": [ "path", "policy_ids" ] }, "PolicyLogPolicy": { "type": "object", "properties": { "id": { "type": "string", "description": "The rule id, as the policy store holds it", "example": "922aa64e-5acc-4f85-aba2-79b92dee6c90" }, "name": { "type": "string", "description": "What the rule was called when it decided. Absent where the set had no catalogue behind it, which is the case for a scope authored in the request itself.", "example": "No air quality lookups", "nullable": true }, "version": { "type": "number", "description": "The version it stood at when it decided, recorded because a rule can be edited afterwards and this decision has to keep meaning what it meant at the time.", "example": 1, "nullable": true }, "level": { "type": "string", "description": "The narrowing level it was assigned at", "example": "project" }, "mode": { "type": "string", "description": "Whether that level was enforcing or only observing", "example": "enforce" }, "effect": { "type": "string", "description": "What it did, absent when it did nothing. Most rules on a call are absent here: they were in force and had no opinion, which is the distinction this record exists to make.", "example": "refused", "enum": [ "refused", "masked", "redacted", "would-have-refused", "would-have-masked", "permitted", "unmapped_value", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } }, "required": [ "id", "level", "mode" ] }, "PolicyLogResolution": { "type": "object", "properties": { "level": { "type": "string", "description": "The level that answered", "example": "org" }, "mode": { "type": "string", "description": "Whether the level was enforcing or only observing", "example": "enforce" }, "decision": { "type": "string", "description": "What the level answered", "example": "allow" }, "determining": { "type": "array", "description": "The rules that determined this level’s answer", "items": { "type": "string" }, "example": [ "base-permit:invokeTool" ] }, "checked": { "type": "array", "description": "Every rule the level was evaluated against, whether or not it decided. The superset of `determining`, and what gives a permissive answer a denominator: a call eleven rules considered and a call nothing was asked about both name no determining rule. Absent on decisions stored before the membership was recorded, which are kept for a year, so treat absent as unknown rather than as no rules having been in force.", "items": { "type": "string" }, "example": [ "922aa64e-5acc-4f85-aba2-79b92dee6c90", "849ea079-41bb-4d96-bbef-63347e6e5b46", "base-permit:invokeTool" ], "nullable": true }, "set_id": { "type": "string", "description": "Identifies the exact policy content the level was evaluated against", "example": "org:enforce:02cd0a414c100f6d", "nullable": true }, "faulted": { "type": "boolean", "description": "True when the evaluator could not answer and the level denied as a result", "example": false, "nullable": true } }, "required": [ "level", "mode", "decision", "determining" ] }, "PreconditionFailedDetails": { "type": "object", "properties": { "status": { "type": "string", "description": "The account status that blocked the request", "enum": [ "suspended", "expired", "archived", "error" ], "example": "suspended", "x-speakeasy-unknown-values": "allow" }, "expiresAt": { "type": "string", "description": "When the test account expired. Present when status is expired", "format": "date-time", "nullable": true }, "statusReasons": { "description": "Why the account is in an error state. Present when status is error", "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/StatusReason" } } }, "required": [ "status" ] }, "PreconditionFailedResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 412 }, "message": { "type": "string", "description": "Error message", "example": "Account is suspended and cannot process requests" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" }, "errorCode": { "type": "string", "description": "Identifies which account status blocked the request", "enum": [ "AccountSuspendedError", "AccountExpiredError", "AccountArchivedError", "AccountErrorStatus" ], "example": "AccountSuspendedError", "x-speakeasy-unknown-values": "allow" }, "details": { "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/PreconditionFailedDetails" } ] } }, "required": [ "statusCode", "message", "timestamp", "errorCode" ] }, "ProviderError": { "type": "object", "properties": { "status": { "type": "number", "description": "HTTP status code of the provider error", "example": 400, "nullable": true }, "url": { "type": "string", "description": "URL that caused the error", "example": "https://api.provider.com/v1/resource", "nullable": true }, "raw": { "type": "object", "description": "Raw error response from the provider", "example": { "message": "Invalid input parameters" }, "nullable": true }, "headers": { "type": "object", "description": "Response headers", "example": { "content-type": "application/json", "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5" }, "nullable": true } } }, "ProviderErrorApiModel": { "type": "object", "properties": { "status": { "type": "number", "example": 400, "nullable": true }, "url": { "type": "string", "example": "https://api.someprovider.com/v1/endpoint", "nullable": true }, "raw": { "type": "object", "nullable": true }, "headers": { "type": "object", "example": { "date": "Tue, 02 Apr 2024 13:52:01 GMT", "content-type": "application/json; charset=utf-8", "transfer-encoding": "chunked", "connection": "close" }, "nullable": true } } }, "ProviderLogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ProviderLogsQueryDto" } ] } } }, "ProviderLogsQueryDto": { "type": "object", "properties": { "request_id": { "description": "Filter by request IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "account_secure_id": { "description": "Filter by account IDs", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "id": { "description": "Filter by provider log IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "ProxyRequestBody": { "type": "object", "properties": { "url": { "type": "string", "description": "The base url of the request", "example": "https://api.sample-integration.com/v1", "nullable": true }, "method": { "type": "string", "description": "The method of the request", "enum": [ "get", "post", "put", "delete", "patch", null ], "default": "get", "nullable": true, "x-speakeasy-unknown-values": "allow" }, "path": { "type": "string", "description": "The path of the request including any query parameters", "example": "/employees/directory", "nullable": true }, "headers": { "type": "object", "description": "The headers to send in the request", "additionalProperties": true, "example": { "Content-Type": "application/json" }, "nullable": true }, "body": { "type": "object", "description": "The body of the request", "additionalProperties": true, "nullable": true } } }, "ProxyResponseApiModel": { "type": "object", "properties": { "status": { "type": "number", "description": "The HTTP status code returned by the provider", "example": 200 }, "headers": { "type": "object", "description": "The headers returned by the provider", "example": { "content-type": "application/json", "x-request-id": "123e4567-e89b-12d3-a456-426614174000" }, "additionalProperties": true, "nullable": true }, "data": { "description": "The response data from the provider. Can be an object, array, or primitive value.", "example": { "id": "123", "name": "John Doe", "email": "john.doe@example.com" }, "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ], "nullable": true }, "provider_errors": { "description": "Provider-specific errors if any occurred", "example": [ { "status": 400, "url": "https://api.someprovider.com/v1/endpoint", "raw": { "error": "Bad Request", "message": "The supplied data is invalid" }, "headers": { "date": "Tue, 02 Apr 2024 13:52:01 GMT", "content-type": "application/json; charset=utf-8" } } ], "nullable": true, "type": "array", "items": { "$ref": "#/components/schemas/ProviderErrorApiModel" } } }, "required": [ "status" ] }, "RequestTimedOutResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 408 }, "message": { "type": "string", "description": "Error message", "example": "Request timed out" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "ScopeDefinitionMetaItem": { "type": "object", "properties": { "name": { "type": "string", "description": "The scope name" }, "description": { "type": "string", "description": "The scope description" }, "includes": { "description": "The scopes auto-included within this scope", "nullable": true, "type": "array", "items": { "type": "string" } } }, "required": [ "name", "description" ] }, "StatusReason": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "timestamp" ] }, "StepLog": { "type": "object", "properties": { "log_type": { "type": "string", "description": "The type of log", "enum": [ "step" ], "example": "step", "x-speakeasy-unknown-values": "allow" }, "action_run_id": { "type": "string", "description": "The action run ID", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "step_index": { "type": "number", "description": "The step index", "example": 0 }, "step_id": { "type": "string", "description": "The step ID", "example": "step-123", "nullable": true }, "step_function_name": { "type": "string", "description": "The step function name", "example": "fetchEmployees", "nullable": true }, "step_function_version": { "type": "string", "description": "The step function version", "example": "1.0.0", "nullable": true }, "step_iterations": { "type": "number", "description": "The number of iterations", "example": 1, "nullable": true }, "event_time": { "type": "string", "description": "The event ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "start_time": { "type": "string", "description": "The request start time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "description": "The request end time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "duration_ms": { "type": "number", "description": "The duration in milliseconds", "example": 356, "nullable": true }, "project_id": { "type": "string", "description": "The project ID", "example": "dev-project-68574", "nullable": true }, "account_id": { "type": "string", "description": "The account ID", "example": "45355976281015164504", "nullable": true }, "skipped": { "type": "boolean", "description": "Whether the step was skipped", "example": false, "nullable": true }, "success": { "type": "boolean", "description": "The success flag", "example": true, "nullable": true }, "status_code": { "type": "number", "description": "The HTTP status code", "example": 200, "nullable": true }, "message": { "type": "string", "description": "The message", "example": "Step completed successfully", "nullable": true } }, "required": [ "log_type", "action_run_id", "step_index" ] }, "StepLogsPaginated": { "type": "object", "properties": { "query": { "type": "object", "description": "Pagination metadata", "example": { "page": 1, "page_size": 25 }, "nullable": true }, "total": { "type": "number", "description": "Total number of logs", "example": 100, "nullable": true }, "data": { "description": "The list of step logs", "type": "array", "items": { "$ref": "#/components/schemas/StepLog" } } }, "required": [ "data" ] }, "StepsLogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/StepsLogsQueryDto" } ] } } }, "StepsLogsQueryDto": { "type": "object", "properties": { "action_run_id": { "description": "Filter by action run IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "account_secure_id": { "description": "Filter by account IDs", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "step_id": { "description": "Filter by step IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "step_index": { "description": "Filter by step indexes", "nullable": true, "type": "array", "items": { "type": "number" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "SupportMeta": { "type": "object", "properties": { "link": { "type": "string", "description": "Link to support documentation", "nullable": true }, "description": { "type": "string", "description": "Support description", "nullable": true }, "guides": { "description": "Authentication guides for this authentication type", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/AuthenticationGuidesMeta" } ] } } }, "TooManyRequestsResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 429 }, "message": { "type": "string", "description": "Error message", "example": "Too many requests" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "UnauthorizedResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 401 }, "message": { "type": "string", "description": "Error message", "example": "Unauthorized" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "UnifiedError": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 400, "nullable": true }, "message": { "type": "string", "description": "Error message", "example": "Bad Request", "nullable": true }, "headers": { "type": "object", "description": "Response headers", "example": { "content-type": "application/json", "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5" }, "nullable": true } } }, "UnifiedLog": { "type": "object", "properties": { "log_id": { "type": "string", "description": "The unique log identifier", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "log_type": { "type": "string", "description": "The type of log", "enum": [ "unified" ], "example": "unified", "x-speakeasy-unknown-values": "allow" }, "event_time": { "type": "string", "description": "The event ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "start_time": { "type": "string", "description": "The request start time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "description": "The request end time ISO8601 date string", "example": "2021-01-01T00:00:00Z", "format": "date-time", "nullable": true }, "duration_ms": { "type": "number", "description": "The duration in milliseconds", "example": 356, "nullable": true }, "project_id": { "type": "string", "description": "The project ID", "example": "dev-project-68574", "nullable": true }, "account_id": { "type": "string", "description": "The account ID", "example": "45355976281015164504", "nullable": true }, "success": { "type": "boolean", "description": "The success flag", "example": true, "nullable": true }, "status_code": { "type": "number", "description": "The HTTP status code", "example": 200, "nullable": true }, "connector_key": { "type": "string", "description": "The connector key", "example": "workday", "nullable": true }, "connector_version": { "type": "string", "description": "The connector version", "example": "1.0.0", "nullable": true }, "connector_owner": { "type": "string", "description": "The connector owner", "example": "stackone", "nullable": true }, "connector": { "description": "The connector display data — name, logo and categories. Only present when requested via `?expand=connector`; `connector_key`, `connector_version` and `connector_owner` are always returned regardless.", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/LogConnectorApiModel" } ] }, "mode": { "type": "string", "description": "The mode", "example": "production", "nullable": true }, "http_method": { "type": "string", "description": "The HTTP method", "example": "GET", "nullable": true }, "url": { "type": "string", "description": "The request URL", "example": "https://api.stackone.com/unified/hris/employees", "nullable": true }, "source_type": { "type": "string", "description": "The source type", "example": "DASHBOARD", "nullable": true }, "source_id": { "type": "string", "description": "The source ID", "example": "1234567890", "nullable": true }, "source_value": { "type": "string", "description": "The source value", "example": "ACCOUNT_TESTER", "nullable": true }, "auth_type": { "type": "string", "description": "The authentication type", "example": "API_KEY", "nullable": true }, "auth_id": { "type": "string", "description": "The authentication ID", "example": "auth-123", "nullable": true }, "user_agent": { "type": "string", "description": "The user agent", "example": "Mozilla/5.0", "nullable": true }, "ip_address": { "type": "string", "description": "The IP address", "example": "192.168.1.1", "nullable": true }, "session_id": { "type": "string", "description": "The session ID", "example": "session-123", "nullable": true }, "agent_id": { "type": "string", "description": "The agent ID", "example": "agent-123", "nullable": true }, "transport_type": { "type": "string", "description": "The transport type", "example": "HTTP", "nullable": true }, "stream_type": { "type": "string", "description": "The stream type", "example": "HTTP", "nullable": true }, "is_background": { "type": "boolean", "description": "Whether this is a background request", "example": false, "nullable": true }, "origin_owner_id": { "type": "string", "description": "The origin owner ID", "example": "owner-123", "nullable": true }, "origin_owner_name": { "type": "string", "description": "The origin owner name", "example": "Test Owner", "nullable": true }, "request_id": { "type": "string", "description": "The request ID", "example": "adbf752f-6457-4ddd-89b3-98ae2252b83b" }, "connector_profile_id": { "type": "string", "description": "The connector profile ID", "example": "profile-123", "nullable": true }, "path": { "type": "string", "description": "The request path", "example": "/unified/hris/employees", "nullable": true }, "resource": { "type": "string", "description": "The resource", "example": "employees", "nullable": true }, "sub_resource": { "type": "string", "description": "The sub resource", "example": "documents", "nullable": true }, "child_resource": { "type": "string", "description": "The child resource", "example": "time-off", "nullable": true }, "service": { "type": "string", "description": "The service", "example": "hris", "nullable": true }, "action": { "type": "string", "description": "The action", "example": "list", "nullable": true }, "provider": { "type": "string", "description": "The provider", "example": "workday", "nullable": true }, "duration": { "type": "number", "description": "The duration in milliseconds (legacy field)", "example": 356, "nullable": true }, "is_worker": { "type": "boolean", "description": "Whether this request was handled by a worker", "example": false, "nullable": true }, "status": { "type": "number", "description": "The response status (legacy field)", "example": 200, "nullable": true } }, "required": [ "log_id", "log_type", "request_id" ] }, "UnifiedLogsPaginated": { "type": "object", "properties": { "query": { "type": "object", "description": "Pagination metadata", "example": { "page": 1, "page_size": 25 }, "nullable": true }, "total": { "type": "number", "description": "Total number of logs", "example": 100, "nullable": true }, "data": { "description": "The list of unified logs", "type": "array", "items": { "$ref": "#/components/schemas/UnifiedLog" } } }, "required": [ "data" ] }, "UnifiedLogsPostDto": { "type": "object", "properties": { "page": { "type": "number", "description": "The page number of the results to return", "minimum": 1, "example": 1, "nullable": true }, "page_size": { "type": "number", "description": "The number of results per page", "minimum": 1, "maximum": 250, "example": 25, "nullable": true }, "filters": { "description": "The filters to apply to the results", "nullable": true, "type": "object", "allOf": [ { "$ref": "#/components/schemas/UnifiedLogsQueryDto" } ] } } }, "UnifiedLogsQueryDto": { "type": "object", "properties": { "request_id": { "description": "Filter by request IDs", "example": [ "adbf752f-6457-4ddd-89b3-98ae2252b83b" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "account_secure_id": { "description": "Filter by account IDs", "example": [ "45355976281015164504" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_key": { "description": "Filter by connector keys", "example": [ "slack" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "connector_profile_id": { "description": "Filter by connector profile IDs", "nullable": true, "type": "array", "items": { "type": "string" } }, "resource": { "description": "Filter by resources", "example": [ "employees" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "service": { "description": "Filter by services", "example": [ "hris" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "action": { "description": "Filter by actions", "example": [ "create_employee" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "origin_owner_id": { "description": "Filter by origin owner IDs", "example": [ "owner-123" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "http_method": { "type": "array", "description": "Filter by HTTP methods", "x-speakeasy-unknown-values": "allow", "nullable": true, "items": { "type": "string", "enum": [ "get", "post", "put", "delete", "patch", null ] } }, "status_code": { "description": "Filter by HTTP status codes", "example": [ "200" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_type": { "description": "Filter by source types", "example": [ "DASHBOARD" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "source_id": { "description": "Filter by source IDs", "example": [ "1234567890" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "mode": { "description": "Filter by modes", "example": [ "production" ], "nullable": true, "type": "array", "items": { "type": "string" } }, "success": { "type": "boolean", "description": "Filter by success status", "example": true, "nullable": true }, "start_time": { "type": "string", "description": "The start of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-01T00:00:00.000Z", "nullable": true }, "end_time": { "type": "string", "description": "The end of the time range to filter by (ISO 8601 timestamp)", "example": "2025-01-31T23:59:59.999Z", "nullable": true }, "order_by": { "type": "string", "description": "The field to order the results by", "enum": [ "start_time", "end_time", "event_time", "duration_ms", null ], "x-speakeasy-unknown-values": "allow", "nullable": true }, "order_direction": { "type": "string", "description": "The direction to order the results by", "enum": [ "asc", "desc", null ], "x-speakeasy-unknown-values": "allow", "nullable": true } } }, "UnprocessableEntityResponse": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code", "example": 422 }, "message": { "type": "string", "description": "Error message", "example": "Unprocessable Entity" }, "timestamp": { "type": "string", "description": "Timestamp when the error occurred", "example": "2023-05-30T00:00:00.000Z", "format": "date-time" } }, "required": [ "statusCode", "message", "timestamp" ] }, "UpsertConnectorProfilePinnedVersion": { "type": "object", "properties": { "pinned_version": { "type": "string", "description": "The version to pin for the connector profile" }, "owner": { "type": "string", "description": "The owner of the pinned version" } }, "required": [ "pinned_version" ] } } } }