πŸš€ Quick Start

This guide helps you get up and running with the Questback Public API.
You'll learn how to obtain credentials, authenticate, and make your first API call.

Tip! if you are familiar with Postman see Api Tools - Postman


βœ… PrerequisitesCopied!

Before you begin, ensure you have the following:

  • OAuth Credentials: A Client ID and Client Secret.
  • HTTP Client: Any REST-capable tool such as curl, Postman, or your preferred development environment.
  • Basic Knowledge: Familiarity with RESTful APIs and OAuth 2.0 authentication flows.

πŸ” Obtaining OAuth CredentialsCopied!

To access the API, you'll need a set of valid OAuth credentials.

  1. Get Credentials from the Account Owner or Support:
    The account owner should have access to a Client ID and Client Secret.
    Alternatively, they can generate a test token for you to use.

  2. Store Credentials Securely:
    Keep your credentials secure. You'll need them to request an access token.


🎟️ Requesting an Access TokenCopied!

Use your credentials to request an access token from the OAuth server.

Example (using curl)Copied!

curl -X POST "https://auth.questback.com/oauth/v2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&scope=urn:zitadel:iam:org:project:id:314876184947078893:aud&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

Expected ResponseCopied!

{
  "access_token": "YOUR_ACCESS_TOKEN",
  "token_type": "Bearer",
  "expires_in": 43199
}

πŸ’‘ Note: Save the access_token β€” you’ll need it for all subsequent API calls.


πŸ§ͺ Making Your First API CallCopied!

Use the /quests endpoint to verify your token and check your access:

curl -X GET "https://api.questback.com/quests" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

πŸ”“ Gaining Access to Real QuestsCopied!

Access to most API endpoints requires permission to specific quests.

  • The /quests endpoint lists all quests you currently have access to.
  • If this list is empty, the account owner must contact Questback Support to grant access.
  • Access is required per quest β€” if a quest is not returned from /quests, you cannot interact with it through the API.

🧭 Exploring the API ReferenceCopied!

You can explore and test endpoints interactively via the API Reference:

To test an endpoint:Copied!

  1. Go to the API Reference
  2. Select the endpoint you want to test.
  3. Click Test Request
  4. In the Authentication section, enter your access_token in the Bearer Token field.
  5. Fill in any required input fields.
  6. Click Send

With these steps, you're ready to begin working with the Questback Public API!