Mock sample for your project: API docs

Integrate with " API docs" from in no time with Mockoon's ready to use mock sample API docs

Version: 1.0.0

Use this API in your project

Speed up your application development by using " API docs" ready-to-use mock sample. Mocking this API will help you accelerate your development lifecycles and allow you to stop relying on an external API to get the job done. No more API keys to provision, accesses to configure or unplanned downtime, just work.
Enhance your development infrastructure by mocking third party APIs during integrating testing.


The API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API is hosted on
Official SDKs
Our SDKs are designed to help you interact with our APIs with less friction. They are written in several different languages and help bridge the gap between your application and APIs. They take away the need to know the exact URL and HTTP method to use for each API call among other things leaving you more time to focus on making your application.
| Language | Package | Source code |
| 💚 Node.js | npm install @journyio/sdk | |
| 🐘 PHP | composer require journy-io/sdk | |
| 🐍 Python | pip install journyio-sdk | |
| 💎 Ruby | Coming soon | Coming soon |
Your favourite programming language not included? Let us know!
In the meanwhile, you can use OpenAPI Generator to generate a client for your programming language.
The API uses API keys to authenticate requests. You can view and manage your API keys in the connections screen.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
For every request send to the API we expect a header X-Api-Key to be set with the API Key.
When creating an API Key in the application you will have the choice to give permissions to an API Key (which you can change later on). These permissions restrict the API Key from different actions. When an API Key tries to perform a certain action it doesn't have the permissions for, you will receive a 401: Unauthorized response.
Rate limiting
To prevent abuse of the API there is a maximum throughput of 100 requests per minute. If you need a higher throughput, please contact us.
To keep our platform healthy and stable, we'll block API keys that consistently hit our rate limits. Therefore, please consider taking this throughput into account.
In every response the headers X-RateLimit-Limit and X-RateLimit-Remaining will be set. The X-RateLimit-Limit-header will always contain the current limit of requests per minute. The X-RateLimit-Remaining-header will always contain the amount of requests you have left in the current sliding window.
Errors uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted). Codes in the 5xx range indicate an error with's servers (these are rare).
When performing a POST- or PUT-request with a requestBody, or when including parameters, these parameters and fields will automatically be checked and validated against the API Spec. When any error occurs, you will get a response with an errors-field, structured as follows:
Looking for a specific endpoint? Documentation not clear? We would love to help!