# mabl API reference Documentation > Understand how to use mabl API endpoints. ## API Reference: Getting started - [mabl API reference](https://api.help.mabl.com/reference/intro-to-the-mabl-api.md): Introduction to the mabl API - [Authentication](https://api.help.mabl.com/reference/authentication.md): How to authenticate mabl API requests - [mabl resource IDs](https://api.help.mabl.com/reference/mabl-resource-ids.md): Overview of mabl resource IDs in API requests and responses - [Pagination](https://api.help.mabl.com/reference/pagination.md): How to retrieve results from paginated endpoints - [Response types](https://api.help.mabl.com/reference/response-types.md): Overview of HTTP response codes and how to troubleshoot errors ## API Reference: mabl API - Account - [List account users](https://api.help.mabl.com/reference/listaccountusers.md): List the users across all workspaces in an account, deduplicated. Each user's roles are scoped to the workspaces within this account. Available to company admins (all users in the account); workspace… - [Get account user](https://api.help.mabl.com/reference/getaccountuser.md): Retrieve a user's details within the context of an account, including their roles across the account's workspaces. Returns 404 if the user has no role in any of the account's workspaces. Available to… - [Account seat allocation and utilization](https://api.help.mabl.com/reference/getaccountseats.md): Allocated, used, and available seats for an account, split by automator and participant. Available is max(allocated - used, 0). Available to company administrators and company-scoped API keys… - [Per-user seat utilization for an account](https://api.help.mabl.com/reference/getaccountseatusage.md): Per-user seat utilization for an account over a calendar month, classifying each active user as an automator or participant based on their automator-event count. Available to company administrators… - Application - [Create application](https://api.help.mabl.com/reference/createapplication.md): Create a new application - [Get applications by workspace](https://api.help.mabl.com/reference/queryapplications.md): Get all applications in a workspace - [Get application by ID](https://api.help.mabl.com/reference/getapplication.md): Get application information by ID - [Update application](https://api.help.mabl.com/reference/updateapplication.md): Update an existing application - [Remove application](https://api.help.mabl.com/reference/removeapplication.md): Remove an application - Company - [List workspaces in a company](https://api.help.mabl.com/reference/getcompanyworkspaces.md): Returns every workspace belonging to the company, grouped by the owning account. Endpoint authorized with a company-scoped API key, or by a company admin user. - [Create a workspace in a company](https://api.help.mabl.com/reference/createcompanyworkspace.md): Creates a new workspace in one of the company's billing accounts. Endpoint authorized with a company-scoped API key, or by a company admin user. - [Rename a workspace](https://api.help.mabl.com/reference/updateworkspace.md): Change a workspace's display name. Available to workspace owners, company owners, and properly permissioned API keys. - [Delete a workspace](https://api.help.mabl.com/reference/deleteworkspace.md): Delete a workspace and everything in it, including its tests, plans, runs and run history. The workspace stops being accessible immediately and cannot be restored through the API; contact mabl… - Credentials - [Create Credentials](https://api.help.mabl.com/reference/createcredentials.md): Create new credentials - [Query Credentials](https://api.help.mabl.com/reference/querycredentials.md): Query for credentials. Decrypted credential provided only if `with_secrets` flag set `true` and is not available for cloud-only credentials. - [Get Credentials](https://api.help.mabl.com/reference/getcredentials.md): Retrieve complete information about credentials. Includes plain text secrets. NOTE: TOTP secret keys are never returned to the client - [Update Credentials](https://api.help.mabl.com/reference/updatecredentials.md): Update existing credentials. NOTE: TOTP tokens will be unchanged if NULL passed. They will be cleared if '' (blank string) is passed. - [Remove Credentials](https://api.help.mabl.com/reference/removecredentials.md): Remove credentials - DataTable - [Create DataTable](https://api.help.mabl.com/reference/createdatatable.md): Create a DataTable in a workspace. The maximum number of scenarios for a DataTable is 1000. - [Get DataTables](https://api.help.mabl.com/reference/querydatatables.md): Query for DataTables in a workspace - [Get DataTable](https://api.help.mabl.com/reference/getdatatable.md): Retrieve metadata about a specific DataTable. To get scenarios for a specific DataTable, use the [get scenarios](https://api.help.mabl.com/reference/queryscenarios) endpoint. - [Update DataTable](https://api.help.mabl.com/reference/putdatatable.md): Update the DataTable name and/or description. Use the [update variables](https://api.help.mabl.com/reference/updatevariablename) and [update scenario](https://api.help.mabl.com/reference/putscenario)… - [Create variable name](https://api.help.mabl.com/reference/createvariablename.md): Add a new variable to an existing DataTable. The variable is appended to all scenarios with an empty string as the default value. Use the [update… - [Get variable names](https://api.help.mabl.com/reference/getvariablenames.md): Get the current variable names for a DataTable - [Update variable name](https://api.help.mabl.com/reference/updatevariablename.md): Update an existing variable's name and apply it to all scenarios in the DataTable - [Delete variable name](https://api.help.mabl.com/reference/removevariablename.md): Remove an existing variable name and its associated values from all scenarios in the DataTable - [Get Scenarios](https://api.help.mabl.com/reference/queryscenarios.md): Retrieve scenarios, variable values, and scenario IDs associated with a DataTable - [Create Scenario](https://api.help.mabl.com/reference/createscenario.md): Create and add a new scenario to a DataTable - [Get Scenario](https://api.help.mabl.com/reference/getscenario.md): Retrieve the variable values for a specific DataTable scenario - [Update Scenario](https://api.help.mabl.com/reference/putscenario.md): Update a scenario and/or its variable values - [Remove Scenario](https://api.help.mabl.com/reference/removescenario.md): Delete a specific scenario from a DataTable using its scenario ID - [Replace Scenarios](https://api.help.mabl.com/reference/reconcilescenarios.md): Reconcile the scenarios of a DataTable to exactly the provided set (a bulk replace). Scenarios whose id matches an existing row are updated, scenarios without a matching id are created, and existing… - DatabaseConnection - [Create database connection](https://api.help.mabl.com/reference/createdatabaseconnection.md): Create a new database connection - [Get database connections by workspace](https://api.help.mabl.com/reference/querydatabaseconnections.md): Returns database connections configured in a workspace - [Get database connection](https://api.help.mabl.com/reference/getdatabaseconnection.md): Get database connection information by ID - [Update database connection](https://api.help.mabl.com/reference/updatedatabaseconnection.md): Update an existing database connection - [Remove database connection](https://api.help.mabl.com/reference/deletedatabaseconnection.md): Remove an existing database connection. Warning: Deleting an existing database connection will cause associated queries to no longer function. We recommend reviewing all associated queries and tests… - Environment - [Create environment](https://api.help.mabl.com/reference/createenvironment.md): Create a new environment - [Get environments by workspace](https://api.help.mabl.com/reference/queryenvironments.md): Get all environments in a workspace - [Get Environment by ID](https://api.help.mabl.com/reference/getenvironment.md): Get environment information by ID - [Update environment](https://api.help.mabl.com/reference/updateenvironment.md): Update an existing environment. **Note** - when you use the update environment endpoint to update environment variables, you completely replace any existing variables. - [Remove environment](https://api.help.mabl.com/reference/removeenvironment.md): Remove an environment - Event - [Get a deployment result summary](https://api.help.mabl.com/reference/getexecutionresultforevent.md): Retrieve information about the plan runs executed using the deployment events API. - [Trigger tests on deployment](https://api.help.mabl.com/reference/ondeploy.md): Create a deployment event to trigger a parallel run of all active plans that meet specified conditions, including application, environment, and plan label. Learn more in [the… - [Query Deployment Events](https://api.help.mabl.com/reference/querydeploymentevents.md): Used to query deployment events - [Query Deployment Events by revision](https://api.help.mabl.com/reference/querydeploymenteventsbyrevision.md): Used to query deployment events by revision (commit ID/SHA) - Flow - [Get flow metadata](https://api.help.mabl.com/reference/getflowmetadata.md): Get the unversioned metadata of an existing flow - [Update flow metadata only](https://api.help.mabl.com/reference/updateflowmetadata.md): Update the unversioned metadata of an existing flow. flow_type is fixed at create; a value sent here is ignored. - Issue - [Create issue](https://api.help.mabl.com/reference/createissue.md) - [Get issue](https://api.help.mabl.com/reference/getissue.md) - [Updates issue](https://api.help.mabl.com/reference/updateissue.md): Updates an issue and marks it to indicate that it needs to be synced to the issue tracker. - [Remove issue](https://api.help.mabl.com/reference/removeissue.md) - [Query workspace issues](https://api.help.mabl.com/reference/queryissuesbyworkspaceid.md) - LinkAgent - [Download Link Agent](https://api.help.mabl.com/reference/redirecttolatestdistribution.md): Redirect the client to download the latest Link Agent distribution - [Query Link Agents](https://api.help.mabl.com/reference/querylinkagents.md): Query for Link Agents by workspace ID - [Terminate Link Agent](https://api.help.mabl.com/reference/terminatelinkagent.md): Send a shutdown signal to a specific Link Agent. When invoked, the Link Agent process will shut down and will not attempt to reconnect. - [Place Link Agent into maintenance mode](https://api.help.mabl.com/reference/enterlinkagentmaintenance.md): Place a Link Agent into maintenance mode. mabl-side routing immediately stops treating the Agent as an active target — legacy Link Servers no longer dispatch new requests to it, and the Agent's… - [Take Link Agent out of maintenance mode](https://api.help.mabl.com/reference/exitlinkagentmaintenance.md): Take a Link Agent out of maintenance mode. mabl-side routing resumes treating the Agent as eligible for new traffic; the Agent resumes accepting new connections on its next status poll. No-op if the… - [Clear all operator-tunable overrides on a Link Agent](https://api.help.mabl.com/reference/clearlinkagentoperatortunablesoverrides.md): Clear every per-Agent operator-tunable override in one call, restoring the Agent to the resolved defaults ⊕ label-level overrides. The resolved `operator_tunables` view is recomputed on the response.… - LinkLabel - [Query Link Labels](https://api.help.mabl.com/reference/querylinklabels.md): Get all Link labels (Link Agent names) associated with a workspace. - [Delete Link Label](https://api.help.mabl.com/reference/deletelinkstack.md): Delete all link assets associated with the provided label (Link Agent name). Use this to clean up Link Tunnels created for ephemeral test environments. - [Clear all operator-tunable overrides on a Link Label](https://api.help.mabl.com/reference/clearlinklabeloperatortunablesoverrides.md): Clear every label-level operator-tunable override in one call, restoring the label's resolved tunables to the static defaults (per-Agent overrides on individual `LinkAgent` records still layer on… - Mailbox - [Create Mailbox](https://api.help.mabl.com/reference/createpermanentmailbox.md): Create new mabl Mailbox address - [Get information on Mailboxes by workspace ID](https://api.help.mabl.com/reference/querymailboxesinworkspace.md): Get permanent email addresses in workspace and number of remaining allowed permanent Mailboxes for workspace - [Get Mailbox](https://api.help.mabl.com/reference/getmailboxaddress.md): Get a Mailbox by email address or ID - [Update Mailbox](https://api.help.mabl.com/reference/updatemailboxaddress.md): Update the name and description of a permanent Mailbox. The email address cannot be changed. - [Delete Mailbox](https://api.help.mabl.com/reference/deletemailboxaddress.md): Delete a Mailbox by ID - [Update Mailbox status](https://api.help.mabl.com/reference/updatemailboxstatus.md): Enable or disable a Mailbox - Reporting - [Get a test run summary](https://api.help.mabl.com/reference/gettestrunresult.md): Retrieve detailed information about a test run and its outcome. - [Get a plan run summary](https://api.help.mabl.com/reference/getplanrunresult.md): Retrieve detailed information about this plan run, including each of its test runs. - [Get test run summaries over a time range](https://api.help.mabl.com/reference/getbatchtestrunresults.md): Get results for a batch of test runs, with filtering available for time range, test/plan labels, test ID, plan ID, application ID, environment ID, and status. - [Create an export of test run artifacts](https://api.help.mabl.com/reference/createtestrunartifactexport.md): Initiate an asynchronous export of specified test run artifacts, such as screenshots or HAR logs. This endpoint returns an export ID. Use the export ID with the [get… - [Retrieve activity feed entries](https://api.help.mabl.com/reference/queryactivityfeed.md): Query the activity feed for a workspace. - [Get a test run artifact export](https://api.help.mabl.com/reference/gettestrunartifactexport.md): Get test run artifact exports using the export ID returned by the [create export](https://api.help.mabl.com/reference/createtestrunartifactexport) endpoint. Once the export status is completed, the… - [Query test run counts](https://api.help.mabl.com/reference/queryworkspacetestruncounts.md): Retrieve the count of test runs in an active workspace, aggregated into time buckets. Each bucket reports the total number of runs that started within the bucket window, as well as how many of those… - [Query account test run counts](https://api.help.mabl.com/reference/queryaccounttestruncounts.md): Same as `/workspaces/{workspace_id}/reports/usage/testRunCounts` but aggregates across every active workspace the authenticated caller has access to within the account. Use this endpoint for… - [Query execution seconds](https://api.help.mabl.com/reference/queryworkspaceexecutionseconds.md): Retrieve total execution time for an active workspace, aggregated into time buckets. The `total_execution_seconds` field sums (end_time - start_time) across every completed run whose `start_time`… - [Query account execution seconds](https://api.help.mabl.com/reference/queryaccountexecutionseconds.md): Same as `/workspaces/{workspace_id}/reports/usage/executionSeconds` but aggregates across every active workspace the authenticated caller has access to within the account. Use this for account-wide… - [Query workspace daily maximum concurrent test runs](https://api.help.mabl.com/reference/queryworkspacemaxtestrunconcurrency.md): Retrieve the daily maximum number of simultaneously executing test runs in an active workspace, along with the workspace's configured test run concurrency limit for the same test type. The reported… - [Query account daily maximum concurrent test runs](https://api.help.mabl.com/reference/queryaccountmaxtestrunconcurrency.md): Same as `/workspaces/{workspace_id}/reports/usage/maxTestRunConcurrency` but returns one block per active workspace the authenticated caller has access to within the account. Each workspace's… - [Retrieve a user's activity across an account](https://api.help.mabl.com/reference/getaccountuseractivity.md): Last-active time and recent action counts for a single user, binned by each workspace in the account where the user was active over the given time range. Restricted to company administrators and… - Test - [Get test metadata](https://api.help.mabl.com/reference/gettestmetadata.md): Get the unversioned metadata of an existing test - [Update test metadata](https://api.help.mabl.com/reference/updatetestmetadata.md): Update the unversioned metadata of an existing test - User - [Query users](https://api.help.mabl.com/reference/queryusers.md): Query for users - [Get workspace user](https://api.help.mabl.com/reference/getworkspaceuser.md): Retrieve a user in the context of a workspace. This will also retrieve high-level user information for any users that were historically in the workspace. Users not in the workspace will be filtered… - [Change a workspace member's role](https://api.help.mabl.com/reference/updateworkspaceuserrole.md): Change a user's role within a workspace. The user must already be a member of the workspace. Available to workspace owners, company owners, and properly permissioned API keys. - [Remove a user from a workspace](https://api.help.mabl.com/reference/removeworkspaceuser.md): Remove a user's role in a workspace. The user's memberships in other workspaces are unaffected. This operation is idempotent - removing a user who is not a member of the workspace returns 204.… - OrganizationInvitation - [Invite user to workspace](https://api.help.mabl.com/reference/createorganizationinvitation.md): Create link or email based workspace invite. For email invites, invite emails are sent to the invited users.