Postman API

Number of APIs: 85

The Qodex API lets you to programmatically access data stored in Qodex account with ease.

Getting started

The easiest way to get started with the Qodex API is to [fork this collection] to your own workspace. You can then use Qodex to send requests.

Overview

You must use a valid API Key to send requests to the API endpoints. You can get your API key from Qodex's integrations dashboard.
The API has access rate limits.
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an "error": {} key.
The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Qodex, and POST implies you want to save something new to Qodex.
API calls respond with the appropriate HTTP status codes for all requests. Within the Qodex client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates success, while an HTTP 4XX or HTTP 5XX response code indicates an error from the requesting client or our API servers, respectively.
Individual resources in your Qodex account are accessible using its unique ID (uid) value. The uid is a simple concatenation of the resource owner's user ID and the resource's ID. For example, a collection's uid is {{owner_id}}-{{collection_id}} value.

ID and UID

All items in Qodex, such as collections, mocks, workspaces, and APIs, have ID and UIDs:

An ID is the unique ID assigned to a Qodex item. For example, ec29121c-5203-409f-9e84-e83ffc10f226.
The UID is the full ID of a Qodex item. This value is the item's unique ID concatenated with the user ID. For example, in the 12345678-ec29121c-5203-409f-9e84-e83ffc10f226 UID:
- 12345678 is the user's ID.
- ec29121c-5203-409f-9e84-e83ffc10f226 is the item's ID.

Authentication

An API key is required to be sent as part of every request to the Qodex API, in the form of an X-Api-Key request header. To get a Qodex API key, you can generate one in the API keys section in your Qodex account settings.

An API key tells the API server that the received request from you. Everything that you have access to in Qodex is accessible with your API key.

For ease of use in Qodex, you can store your API key as the Qodex_api_key environment variable. The Qodex API collection will automatically use it to make API calls.

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code and the following JSON response:

{
  "error": {
    "name": "AuthenticationError",
    "message": "Invalid API Key. Every request requires a valid API Key to be sent."
  }
}

Using the API key as a query parameter

Each request that accepts API key as X-Api-Key request header also accepts the key when it is sent as the apikey query parameter.

An API key sent as part of the header has a higher priority when you send the key as both a request header and a query parameter.

Rate Limits

API access rate limits apply at a per-API key basis in unit time. Access to the API using an API key is limited to 60 requests per minute. In addition, every API response is accompanied by the following set of headers to identify the status of your use:

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

Once you reach the rate limit you will receive a response similar to the following HTTP 429 Too Many Requests response:

{
  "error": {
    "name": "rateLimitError",
    "message": "Rate Limit exceeded. Please retry at 1465452702843"
  }
}

In the event you receive an HTTP 503 response from our servers, it indicates that we have had an unexpected spike in API access traffic. This is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, [contact support]

Support

For help regarding accessing the Qodex API, you can:

Visit [Qodex Support] or our [Community and Support] sites.
Reach out to the [Qodex community]
Submit a help request to [Qodex support]

Policies

[Qodex Terms of Service]
[Qodex Privacy Policy]