Qase Docs
Help CenterAPI DocsRoadmapSign up for free
  • General
    • Qase docs
    • Get started with the Qase platform
      • Account settings
      • Projects
      • Test suites
      • Test cases
        • Test Case Parameters
        • Test case review
        • Shared steps
        • Import test cases
        • Export test cases
        • Trash bin
        • Muted Tests
        • System fields
        • Nested steps
        • Test case actions
        • Filters
      • Requirements Traceability Report
      • AI Test Case Generator
    • Execute testing
      • Test plan
      • Test runs
      • Configurations
      • Environments
    • Issues tracking
      • Defects
      • Milestones
      • Requirements
    • Analytics
      • Dashboards
      • Queries (QQL, Qase Query Language)
      • Saved queries
    • Webhooks
      • Test Case
      • Test suite
      • Test plan
      • Shared step
      • Milestone
      • Custom field
      • Test run
      • Defect
      • Test review
  • AIDEN
    • AIDEN - QA Architect
  • Guide: Action editor
  • Administration
    • Workspace management
      • Users
      • Invites
      • Groups
      • Roles
      • Fields
      • Custom fields
      • Notifications
      • Tags
      • Attachments
      • Audit logs
      • Hotkeys
    • SSO / SAML instructions
      • AzureAD
      • OneLogin
      • Google Workspace
      • Okta
      • JumpCloud
    • SCIM
      • User lifecycle management with SCIM
      • Enable SCIM
      • Users
      • Discovery features
      • Errors
    • Security
      • SOC 2 Type II / SOC 3
      • ISO/IEC 27001:2022
      • Penetration testing report
      • Subprocessors
      • Qase IP addresses
    • Billing
      • Billing options
    • Subscriptions
      • Free plan
      • Startup plan
      • Business plan
      • Enterprise plan
  • Apps
    • Issue tracking
      • Jira Cloud
      • Jira Server/Datacenter Plugin installation
      • GitHub
      • Asana
      • Linear
      • Monday
      • ClickUp
      • Trello
      • Azure DevOps
      • GitLab
      • YouTrack
      • Redmine
    • CI/CD
      • Jenkins
      • BitBucket
      • GitHub CI
      • GitLab CI
    • Chats
      • Slack
  • Automation
    • Qase API
    • Reporters
      • JavaScript
        • Playwright
        • Cypress
        • Mocha
        • Newman
        • Jest
        • WebDriverIO
        • CucumberJS
        • TestCafe
      • Python
        • Pytest
        • Robot Framework
        • Behave
        • Tavern
      • Java
        • TestNG
        • JUnit 4
        • JUnit 5
        • Cucumber 3 (jvm)
        • Cucumber 4 (jvm)
        • Cucumber 5 (jvm)
        • Cucumber 6 (jvm)
        • Cucumber 7 (jvm)
      • PHP
        • PHPUnit
        • Codeception
      • Kotlin
        • Kaspresso
    • Qase CLI App
      • XCTest
Powered by GitBook
On this page
  • What can I do with Qase API?
  • What is a token for?
  • How to generate an API Token?
  1. Automation

Qase API

PreviousSlackNextReporters

Last updated 4 months ago

What can I do with Qase API?

Qase provides API methods that you can utilize to interact with it, set up custom integrations or create your own solutions to submit automated execution results into Qase test runs.

You can refer to full API documentation to learn more here:

Also, you can find a public collection on Postman here:

What is a token for?

API requests to Qase are authenticated with the auth token. In order to perform actions in your workspace using API, you will need to obtain a token first.

How to generate an API Token?

Here's how to create an API token:

1. Click your user pic and hit "API Tokens".

2. Click "Create a new API token" to proceed. You can set up an unlimited number of tokens for your needs.

3. Give your token a title and hit "Create".

Note: after you click the "Create" button, a token will be displayed. Copy the token as it will only be shown once. Otherwise, you will need to create a new token.

To discontinue the token, you can "Revoke" it through the three-dot-menu:

Scope of permissions: an API token inherits the permissions that a user issuing it has in the workspace. For example, if your does not allow you to create test runs, you will not be able to create test runs while using Qase UI or by sending an API request.

user role
https://developers.qase.io
https://www.postman.com/qaseio?tab=collections