Joinways Analytics API

openapi: 3.2.0
info:
  title: Joinways Public Analytics API
  version: 1.15.0
  description: 'The Joinways REST API lets you read and manage your CRM and event data:

    events, quotes, invoices, companies, contacts, leads (requests), venues,

    catalog, tasks, reports and more. It is a **JSON over HTTPS** API described by

    this OpenAPI 3.1 document, served at `https://joinways.app/openapi.yaml`

    and rendered at `https://joinways.app/docs/api`. The same data is reachable from AI assistants through the Joinways MCP

    server (`https://mcp.joinways.app`, guide at

    `https://joinways.app/docs/claude-mcp`): both surfaces share the OAuth

    server, the tokens, the scopes, the role permissions and the services of

    the app, so a rule holds the same way in the app, in the REST API and in

    MCP. ## Authentication


    Every request needs a **Bearer token** in the `Authorization` header:


    ```

    Authorization: Bearer jw_xxxxxxxx

    ```


    Two token types work:


    - **API key** (`jw_…`): an owner or admin creates one from **Settings →

    Developers → API keys** in the workspace (guide:

    `https://joinways.app/docs/api-keys`). An API key acts as the member

    who created it: it carries the read and write scopes, and the **role

    permissions its creator holds now** in the workspace (see below; a

    creator who leaves the workspace takes the key''s access with them). It

    does not expire unless you set an expiry, and can be revoked at any

    time from the same page. - **OAuth 2.1 access token** (`jw_oat_…`): for apps acting on a user''s

    behalf (Authorization Code + PKCE S256, same flow as the MCP server). - Authorization endpoint `https://joinways.app/oauth/authorize`, token

    endpoint `https://joinways.app/api/oauth/token`, revocation

    `https://joinways.app/api/oauth/revoke` (RFC 7009), metadata

    `https://joinways.app/.well-known/oauth-authorization-server`. - **Clients**: register with Dynamic Client Registration

    (`POST /api/oauth/register`), or use an https URL as `client_id`

    (Client ID Metadata Document). - **Resource** (RFC 8707): send `resource=https://joinways.app/api/v1`

    on the authorization and token requests to bind the token to this API

    (a token bound to `https://mcp.joinways.app` is refused here, and the

    other way round). An unknown resource is refused with

    `invalid_target`. Protected resource metadata:

    `https://joinways.app/.well-known/oauth-protected-resource/api/v1`. - **Refresh**: a client registered with the `refresh_token` grant gets a

    refresh token (`jw_ort_…`) next to a **1 hour** access token. Each

    refresh rotates the refresh token (the old one stops working); a

    refresh token unused for 90 days expires. A client without the

    refresh grant gets a **30 day** access token and re-runs the flow. A refresh may ask for fewer scopes: only the new access token is

    narrowed. A user who left the workspace gets `invalid_grant` on

    refresh, and the whole token family is revoked. - **Granted scope** = requested ∩ supported (`mcp.read`, `mcp.write`)

    ∩ registered by the client. - The authorization response carries `iss` (RFC 9207). The consent

    screen shows the host of a metadata-document client, and warns when

    the `redirect_uri` is on another domain. - A workspace owner sees and revokes connected apps in **Settings →

    Developers → MCP → Connected apps**. A token is **bound to a single workspace**. You never pass an

    `account_id`: the workspace comes from the token. The API is part of

    the **Pro plan and the free trial**: a valid token of a workspace

    without either is refused with `403 forbidden`, `details.reason:

    plan_not_eligible`. Revocation takes effect within about a minute

    across our infrastructure. Tokens are stored hashed (SHA-256) and shown

    once. A `401` carries the RFC 6750 / RFC 9728 challenge:


    ```

    WWW-Authenticate: Bearer resource_metadata="https://joinways.app/.well-known/oauth-protected-resource/api/v1", scope="mcp.read mcp.write"

    ```


    ## Scopes


    | Scope | Grants |

    |---|---|

    | `mcp.read` | Every `GET` |

    | `mcp.write` | Every `POST`, `PATCH`, `PUT`, `DELETE`, and reading (it implies `mcp.read`) |


    API keys carry both scopes.'
  contact:
    name: Joinways
    url: https://joinways.app
  license:
    name: Proprietary
  x-logo:
    url: /images/marketing/logo-header.svg
    altText: Joinways
    href: https://joinways.app
servers:
- url: https://joinways.app/api/v1
  description: Production
security:
- bearerAuth: []
- oauth2:
  - mcp.read
  - mcp.write
tags:


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/joinways-app/openapi/joinways-app-analytics-api-openapi.yml