Skip to content

OpenAPI Specification

The Contio Partner API is fully documented using OpenAPI (Swagger) specification.

Browse Interactive API Reference

Download Specifications

Using the OpenAPI Spec

Import into Postman

  1. Open Postman
  2. Click Import in the top left
  3. Select the partner_postman_collection.json file
  4. Configure your environment variables:
  5. baseUrl: https://api.contio.ai
  6. partner_client_id: Your client ID
  7. partner_client_secret: Your client secret
  8. partner_api_key: Your API key

Generate Client Code

Use the OpenAPI spec to generate client libraries in any language:

# Using OpenAPI Generator
openapi-generator generate \
  -i partner-openapi.json \
  -g typescript-axios \
  -o ./generated-client

# Using Swagger Codegen
swagger-codegen generate \
  -i partner-openapi.json \
  -l python \
  -o ./python-client

View in Swagger UI

You can view the specification in Swagger UI:

  1. Go to Swagger Editor
  2. File → Import File → Select partner-openapi.yaml
  3. Explore the API documentation interactively

Specification Overview

Endpoints Covered

Category Endpoints
OAuth 2.0 /oauth2/authorize, /oauth2/token, /auth/initiate, /auth/verify
User API /v1/partner/user/meetings/*, /v1/partner/user/action-items/*
Admin API /v1/partner/admin/automation/*, /v1/partner/admin/app/*

Authentication Schemes

The spec defines two authentication schemes:

  1. OAuth2 - For user operations on behalf of connected users

    • Token type: Bearer token in Authorization header
    • Scopes: read (data access), write (data modification)
    • See Authentication Guide for OAuth flow details

  2. ApiKey - For admin/management operations

    • Required headers: Both X-API-Key AND X-Client-ID must be provided
    • X-API-Key: Your secret API key (never share or expose in client-side code)
    • X-Client-ID: Your partner application's client ID
    • See REST API Quick Start for examples

Keeping Up to Date

The OpenAPI specification is regenerated with each API release. Check the version in the spec:

info:
  title: Contio Partner API
  version: "1.3.0"

Support

Issues with the OpenAPI spec?