Clarifymedical

Clarifymedical Invitations API

The Invitations API from Clarifymedical — 3 operation(s) for invitations.

GitHub OpenAPI

Operations 4

GET /workspaces/{workspace}/invitations List invitations #
POST /workspaces/{workspace}/invitations Invite a user #
DELETE /workspaces/{workspace}/invitations/{invitationId} Revoke an invitation #
POST /workspaces/{workspace}/invitations/{invitationId}/resend Resend an invitation #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/openapi/clarifymedical-invitations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-list-of-workflows-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-workflow-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-workspace-settings-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-create-relationship-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-list-of-activities-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-update-layout-body-dto-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clarifymedical:clarifymedical-invitations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clarifymedical-invitations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Clarify Invitations API
  description: The Clarify API OpenAPI documentation
  version: '0.1'
  contact: {}
servers:
- url: https://api.clarify.ai/v1
security:
- apiKey: []
- bearer: []
tags:
- name: Invitations
paths:
  /workspaces/{workspace}/invitations:
    get:
      description: Returns the workspace’s invitations and their states as a JSON:API list with `links` and `meta`, in one page.
      operationId: getInvitations
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      responses:
        '200':
          description: The workspace’s invitations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationsResponse'
              example:
                links:
                  next: null
                  prev: null
                meta:
                  total_records: 1
                  total_pages: 1
                  offset: 0
                  limit: 500
                data:
                - type: invitation
                  id: invitation_01HXYZACMEJANEDOE00000000
                  attributes:
                    id: invitation_01HXYZACMEJANEDOE00000000
                    invitee_email: jane@acme.com
                    status: pending
        '403':
          description: The API key has no user behind it.
      summary: List invitations
      tags:
      - Invitations
    post:
      description: Emails an invitation to join the workspace and returns the outcome as a JSON:API resource. Inviting someone with a pending invitation resends it, and inviting an existing member sends nothing and returns a `null` id.
      operationId: createInvitation
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: silent
        in: query
        required: false
        schema:
          type: boolean
        description: When true, suppresses in-app and Slack notifications for this mutation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvitationDto'
            examples:
              invite:
                summary: Invite a teammate by email
                value:
                  data:
                    type: invitation
                    attributes:
                      email: jane@acme.com
      responses:
        '201':
          description: The invitation outcome.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInvitationResponse'
              example:
                data:
                  type: invitation
                  id: invitation_01HXYZACMEJANEDOE00000000
                  attributes:
                    id: invitation_01HXYZACMEJANEDOE00000000
                    invitee_email: jane@acme.com
                    message: Invitation sent to jane@acme.com
        '401':
          description: The request did not send a bearer access token.
        '403':
          description: The caller cannot manage workspace users.
      security:
      - bearer: []
      summary: Invite a user
      tags:
      - Invitations
  /workspaces/{workspace}/invitations/{invitationId}:
    delete:
      description: Revokes a pending invitation so it can no longer be accepted.
      operationId: revokeInvitation
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: invitationId
        required: true
        in: path
        description: The unique ID of the invitation.
        schema:
          type: string
      - name: silent
        in: query
        required: false
        schema:
          type: boolean
        description: When true, suppresses in-app and Slack notifications for this mutation.
      responses:
        '204':
          description: The invitation was revoked.
        '401':
          description: The request did not send a bearer access token.
        '403':
          description: The caller cannot manage workspace users.
        '404':
          description: The invitation does not belong to this workspace.
      security:
      - bearer: []
      summary: Revoke an invitation
      tags:
      - Invitations
  /workspaces/{workspace}/invitations/{invitationId}/resend:
    post:
      description: Sends the invitation email again for a pending invitation.
      operationId: resendInvitation
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: invitationId
        required: true
        in: path
        description: The unique ID of the invitation.
        schema:
          type: string
      - name: silent
        in: query
        required: false
        schema:
          type: boolean
        description: When true, suppresses in-app and Slack notifications for this mutation.
      responses:
        '204':
          description: The invitation email was resent.
        '401':
          description: The request did not send a bearer access token.
        '403':
          description: The caller cannot manage workspace users.
        '404':
          description: The invitation does not belong to this workspace.
      security:
      - bearer: []
      summary: Resend an invitation
      tags:
      - Invitations
components:
  schemas:
    CreateInvitationResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - invitation
              description: The resource type, always `invitation`.
            id:
              type: string
              nullable: true
              description: The unique ID of the invitation, or `null` when the person is already a member.
            attributes:
              type: object
              properties:
                id:
                  type: string
                  nullable: true
                  description: The unique ID of the invitation, or `null` when the person is already a member.
                invitee_email:
                  type: string
                  description: The email address the invitation went to.
                message:
                  type: string
                  description: A sentence describing the outcome, suitable to show a user.
              required:
              - id
              - invitee_email
              - message
              description: The invitation outcome.
            relationships:
              type: object
              properties: {}
              description: Always empty for invitations.
          required:
          - type
          - id
          - attributes
          description: The resource.
      required:
      - data
    CreateInvitationDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - invitation
              description: The resource type, always `invitation`.
            attributes:
              description: Field values keyed by field name; available fields depend on the object’s schema. System fields (prefixed with a single `_`) cannot be set.
              type: object
              properties:
                email:
                  type: string
                  format: email
                  description: The email address of the person to invite.
              required:
              - email
              additionalProperties: true
          required:
          - type
          - attributes
          additionalProperties: false
          description: The resource to create.
      required:
      - data
    InvitationsResponse:
      type: object
      properties:
        links:
          type: object
          properties:
            next:
              type: string
              nullable: true
              description: URL of the next page, or `null` on the last page.
            prev:
              type: string
              nullable: true
              description: URL of the previous page, or `null` on the first page.
          required:
          - next
          - prev
          description: Pagination links.
        meta:
          type: object
          properties:
            total_records:
              type: number
              description: Total number of records across all pages.
            total_pages:
              type: number
              description: Total number of pages at the current page size.
          required:
          - total_records
          - total_pages
          description: Pagination metadata.
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - invitation
                description: The resource type; matches the `object` path parameter.
              id:
                type: string
                description: The unique ID of the resource.
              attributes:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique ID of the invitation.
                  invitee_email:
                    type: string
                    description: The email address the invitation went to.
                  status:
                    type: string
                    enum:
                    - pending
                    - accepted
                    - expired
                    - revoked
                    description: 'The invitation state: `pending`, `accepted`, `expired`, or `revoked`.'
                required:
                - id
                - invitee_email
                - status
                description: Field values keyed by field name; available fields depend on the object’s schema.
              relationships:
                type: object
                properties: {}
                description: Related resources keyed by relationship name, present when requested via `include`.
            required:
            - type
            - id
            - attributes
          description: The page of resources.
      required:
      - links
      - meta
      - data
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key authentication. Send your key in the Authorization header as: `api-key <your-api-key>`.'
    bearer:
      type: http
      scheme: bearer
      description: 'User access token authentication. Every endpoint accepts it, and endpoints that act as a person accept only it. Send a WorkOS access token in the Authorization header as: `Bearer <token>`.'