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-workspaces-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

openapi: 3.2.0
info:
  title: Clarify Workspaces API
  description: The Clarify API OpenAPI documentation
  version: '0.1'
  contact: {}
servers:
- url: https://api.clarify.ai/v1
security:
- apiKey: []
- bearer: []
tags:
- name: Workspaces
paths:
  /workspaces:
    get:
      description: 'Returns every workspace the signed-in user belongs to as a JSON:API list with `links` and `meta`, in one page. Requires a user access token sent as `Authorization: Bearer `; an API key gets 401 because it belongs to one workspace.'
      operationId: listWorkspaces
      parameters: []
      responses:
        '200':
          description: The workspaces the user belongs to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOfWorkspacesResponseDto'
              example:
                links:
                  next: null
                  prev: null
                meta:
                  total_records: 1
                  total_pages: 1
                  offset: 0
                  limit: 500
                data:
                - type: workspace
                  id: 3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13
                  attributes:
                    slug: acme
                    name: Acme Corp
                    organization_id: org_01HXYZACMECORP0000000000
                    created_at: '2026-01-15T09:30:00.000Z'
        '401':
          description: The request carries an API key or no valid access token.
      security:
      - bearer: []
      summary: List workspaces
      tags:
      - Workspaces
    post:
      description: 'Creates a workspace owned by the signed-in user and returns it as a JSON:API resource once it is ready to use. Requires a user access token sent as `Authorization: Bearer `. Retrying after a failure resumes the unfinished workspace instead of creating a second one, and repeating a create with the same name within ten minutes returns that workspace with status 200 and `meta.existing` set.'
      operationId: createWorkspace
      parameters:
      - 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/CreateWorkspaceRequestDto'
            examples:
              create:
                summary: Create a workspace that teammates join by email domain
                value:
                  data:
                    type: workspace
                    attributes:
                      name: Acme Corp
                      domain_join: true
                      region: NA
      responses:
        '200':
          description: A workspace this user created with the same name in the last ten minutes, with `meta.existing` set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponseDto'
              example:
                data:
                  type: workspace
                  id: 3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13
                  attributes:
                    slug: acme
                    name: Acme Corp
                    organization_id: org_01HXYZACMECORP0000000000
                    created_at: '2026-01-15T09:30:00.000Z'
                meta:
                  existing: true
        '201':
          description: The created workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponseDto'
              example:
                data:
                  type: workspace
                  id: 3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13
                  attributes:
                    slug: acme
                    name: Acme Corp
                    organization_id: org_01HXYZACMECORP0000000000
                    created_at: '2026-01-15T09:30:00.000Z'
                meta:
                  existing: false
        '401':
          description: The request carries an API key or no valid access token.
        '403':
          description: The user already has a workspace and self-serve creation of another one is not enabled for them.
        '409':
          description: Another request is creating a workspace for this user.
      security:
      - bearer: []
      summary: Create a workspace
      tags:
      - Workspaces
  /workspaces/{workspace}:
    get:
      description: Returns a single workspace as a JSON:API resource, including the WorkOS organization ID used to mint an access token for it.
      operationId: getWorkspace
      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 requested workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponseDto'
              example:
                data:
                  type: workspace
                  id: 3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13
                  attributes:
                    slug: acme
                    name: Acme Corp
                    organization_id: org_01HXYZACMECORP0000000000
                    created_at: '2026-01-15T09:30:00.000Z'
        '404':
          description: The workspace does not exist.
      summary: Get a workspace
      tags:
      - Workspaces
    patch:
      description: Changes the workspace display name and returns the updated JSON:API resource. The slug never changes. Requires an admin signed in with a user access token.
      operationId: updateWorkspace
      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/UpdateWorkspaceRequestDto'
            examples:
              rename:
                summary: Rename the workspace
                value:
                  data:
                    type: workspace
                    attributes:
                      name: Acme Corporation
      responses:
        '200':
          description: The renamed workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponseDto'
              example:
                data:
                  type: workspace
                  id: 3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13
                  attributes:
                    slug: acme
                    name: Acme Corporation
                    organization_id: org_01HXYZACMECORP0000000000
                    created_at: '2026-01-15T09:30:00.000Z'
        '401':
          description: The request did not send a bearer access token.
        '403':
          description: The caller is not a workspace admin.
      security:
      - bearer: []
      summary: Rename a workspace
      tags:
      - Workspaces
components:
  schemas:
    ListOfWorkspacesResponseDto:
      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:
                - workspace
                description: The resource type; matches the `object` path parameter.
              id:
                type: string
                description: The unique ID of the resource.
              attributes:
                type: object
                properties:
                  slug:
                    type: string
                    description: The workspace slug, the `{slug}` segment of the workspace URL. It never changes after creation.
                  name:
                    type: string
                    description: The workspace display name.
                  organization_id:
                    type: string
                    nullable: true
                    description: The WorkOS organization ID that backs the workspace, used to mint an access token scoped to it.
                  created_at:
                    type: string
                    format: date-time
                    description: The time the workspace was created.
                required:
                - slug
                - name
                - organization_id
                - created_at
                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
    UpdateWorkspaceRequestDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - workspace
              description: The resource type, always `workspace`.
            attributes:
              type: object
              properties:
                name:
                  description: 'The workspace display name: at least 5 characters of letters, numbers, spaces, periods, and hyphens. The slug derives from it at creation.'
                  type: string
                  minLength: 5
                  pattern: ^[a-zA-Z0-9 .-]+$
              required:
              - name
          required:
          - type
          - attributes
          description: The changes to apply to the workspace.
      required:
      - data
    WorkspaceResponseDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - workspace
              description: The resource type; matches the `object` path parameter.
            id:
              type: string
              description: The unique ID of the resource.
            attributes:
              type: object
              properties:
                slug:
                  type: string
                  description: The workspace slug, the `{slug}` segment of the workspace URL. It never changes after creation.
                name:
                  type: string
                  description: The workspace display name.
                organization_id:
                  type: string
                  nullable: true
                  description: The WorkOS organization ID that backs the workspace, used to mint an access token scoped to it.
                created_at:
                  type: string
                  format: date-time
                  description: The time the workspace was created.
              required:
              - slug
              - name
              - organization_id
              - created_at
              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 resource.
      required:
      - data
    CreateWorkspaceRequestDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - workspace
              description: The resource type, always `workspace`.
            attributes:
              type: object
              properties:
                name:
                  description: 'The workspace display name: at least 5 characters of letters, numbers, spaces, periods, and hyphens. The slug derives from it at creation.'
                  type: string
                  minLength: 5
                  pattern: ^[a-zA-Z0-9 .-]+$
                domain_join:
                  type: boolean
                  description: When true, anyone signing up with your work email domain joins the workspace automatically. Not available for personal email domains. Defaults to false.
                region:
                  type: string
                  enum:
                  - AF
                  - AN
                  - AS
                  - EU
                  - NA
                  - OC
                  - SA
                  description: 'The continent code of the workspace’s main market: `AF`, `AN`, `AS`, `EU`, `NA`, `OC`, or `SA`.'
              required:
              - name
          required:
          - type
          - attributes
          description: The workspace to create.
      required:
      - data
    CreateWorkspaceResponseDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              enum:
              - workspace
              description: The resource type; matches the `object` path parameter.
            id:
              type: string
              description: The unique ID of the resource.
            attributes:
              type: object
              properties:
                slug:
                  type: string
                  description: The workspace slug, the `{slug}` segment of the workspace URL. It never changes after creation.
                name:
                  type: string
                  description: The workspace display name.
                organization_id:
                  type: string
                  nullable: true
                  description: The WorkOS organization ID that backs the workspace, used to mint an access token scoped to it.
                created_at:
                  type: string
                  format: date-time
                  description: The time the workspace was created.
              required:
              - slug
              - name
              - organization_id
              - created_at
              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 resource.
        meta:
          type: object
          properties:
            existing:
              type: boolean
              description: True when the same user created a workspace with this name in the last ten minutes, so this request (likely a retry) returns that workspace instead of a second one.
          required:
          - existing
      required:
      - data
      - meta
  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>`.'