Skip to main content

​
Access the OpenAPI Specification

The OpenAPI specification defines all endpoints, parameters, request/response schemas, and authentication methods for the Partoo REST API. You can view the specification in an API tool or download it for offline use. Here’s how:
  • Download the complete YAML file
  • Import it into an OpenAPI-compatible tool (Postman, Insomnia, Swagger UI, etc.)
  • Use it to automatically generate an API client (SDK)

​
Download the OpenAPI File (YAML)

Download the full bundled OpenAPI specification: Download OpenAPI Specification (YAML)
The file downloads as a .yaml document and is ready to use in compatible API tools.

​
View the Specification in an API Tool

After downloading the file, you can import it into your preferred API tool.

​
Example: Import into Postman

1

Open Postman

Launch the Postman application.
2

Import the file

Click Import, then select the openapi-bundled.yaml file.
3

Generate the collection

Postman automatically creates a collection containing all available API endpoints.
You can see all API routes listed in your workspace.

​
Generate an API Client Automatically

You can use the OpenAPI specification to generate a typed SDK client.

​
Example with OpenAPI Generator (CLI)

openapi-generator-cli generate \
  -i openapi-bundled.yaml \
  -g typescript-axios \
  -o ./partoo-api-client
This command generates a TypeScript client based on the official API definition.
Always use the latest version of the OpenAPI file to ensure compatibility with recently added or updated endpoints.

​
Need Help?

If you encounter issues while importing or generating a client:
  • Verify that the YAML file is valid
  • Ensure your OpenAPI tool supports the specification version
  • Check the official documentation of the tool you are using
The OpenAPI specification reflects the current version of the Partoo REST API.