Clarifymedical Resources API

The Resources API from Clarifymedical — 4 operation(s) for resources.

Operations 5

GET /workspaces/{workspace}/objects/{object}/resources/{id} Get a resource #
GET /workspaces/{workspace}/objects/{object}/resources List resources #
POST /workspaces/{workspace}/objects/{object}/resources Create a resource #
GET /workspaces/{workspace}/objects/{object}/deleted-resources List deleted resources #
GET /workspaces/{workspace}/objects/{object}/lists/{list}/resources List resources in a list #

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-resources-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.

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

OpenAPI Specification

clarifymedical-resources-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Clarify Resources API
  description: The Clarify API OpenAPI documentation
  version: '0.1'
  contact: {}
servers:
- url: https://api.clarify.ai/v1
security:
- apiKey: []
- bearer: []
tags:
- name: Resources
paths:
  /workspaces/{workspace}/objects/{object}/resources/{id}:
    get:
      description: Returns a single resource as a JSON:API document. Use `include` to embed related resources under `relationships` and return them in `included`.
      operationId: getResource
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: object
        required: true
        in: path
        description: 'The object type: a built-in entity (`person`, `company`, `deal`, …) or a custom object (`c_*`).'
        schema:
          type: string
      - name: id
        required: true
        in: path
        description: The unique ID of the record.
        schema:
          type: string
      - name: include
        required: false
        in: query
        description: Comma-separated relationship names to embed under `relationships` and return in `included`, e.g. `include=company,deals`.
        schema:
          type: string
      responses:
        '200':
          description: The requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceResponse'
              example:
                data:
                  type: person
                  id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                  attributes:
                    _id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                    name:
                      first_name: Jane
                      last_name: Doe
                    email_addresses:
                      items:
                      - jane@acme.com
                    job_title: VP of Marketing
                    company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
                    _created_at: '2026-01-15T09:30:00.000Z'
                    _updated_at: '2026-02-01T17:45:00.000Z'
                included: []
                meta: {}
        '403':
          description: The resource exists but the authenticated caller has no access to it.
        '404':
          description: No resource with this ID exists on the object.
      summary: Get a resource
      tags:
      - Resources
  /workspaces/{workspace}/objects/{object}/resources:
    get:
      description: 'Returns a paginated JSON:API collection of an object’s resources. Use `include` to embed related resources and `filter` to narrow results by field — a bare value is an exact match, including on collection fields (`filter[email_addresses]=jane@acme.com`); shorthand operators are parsed from the value (`filter[status]=active,pending`, `filter[amount]=>100`, `filter[name]=*Smith*`, `filter[assigned]=null`), or name them explicitly (`filter[start][Is on or after]=2025-01-01`, `filter[domains][Contains]=acme`). To filter on a relationship field, include that relationship: `filter[author.name]=John&include=author`.'
      operationId: getResources
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: object
        required: true
        in: path
        description: 'The object type: a built-in entity (`person`, `company`, `deal`, …) or a custom object (`c_*`).'
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Offset pagination, e.g. `page[offset]=0&page[limit]=100`.
        schema:
          properties:
            offset:
              default: 0
              type: number
              minimum: 0
              description: The number of records to skip before the first result.
              required: false
            limit:
              description: The maximum number of records to return per page (up to 500).
              default: 500
              type: number
              minimum: 1
              required: false
          default:
            offset: 0
            limit: 500
          type: object
      - name: sortOrder
        required: false
        in: query
        description: Sort order, e.g. `sortOrder[column]=_created_at&sortOrder[dir]=DESC`.
        schema:
          properties:
            column:
              description: The field name to sort by.
              type: string
              minLength: 1
              required: true
            dir:
              type: string
              enum:
              - ASC
              - DESC
              description: The sort direction.
              required: true
          type: object
      - name: include
        required: false
        in: query
        description: Comma-separated relationship names to embed under `relationships` and return in `included`, e.g. `include=company,deals`.
        schema:
          type: string
      - name: filter
        required: false
        in: query
        description: Nested filter object keyed by field name, e.g. `filter[status]=active` or `filter[amount][Greater than]=100`. See the endpoint description for the full operator syntax.
        schema:
          additionalProperties:
            oneOf:
            - type: string
            - type: object
              additionalProperties:
                type: string
          type: object
      responses:
        '200':
          description: A page of matching resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcesResponse'
              example:
                links:
                  next: null
                  prev: null
                meta:
                  total_records: 1
                  total_pages: 1
                  offset: 0
                  limit: 50
                data:
                - type: person
                  id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                  attributes:
                    _id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                    name:
                      first_name: Jane
                      last_name: Doe
                    email_addresses:
                      items:
                      - jane@acme.com
                    job_title: VP of Marketing
                    company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
                    _created_at: '2026-01-15T09:30:00.000Z'
                    _updated_at: '2026-02-01T17:45:00.000Z'
                included: []
      summary: List resources
      tags:
      - Resources
    post:
      description: Creates a resource of the given object type. The `type` in the body must match the `object` path parameter. Returns the created resource as a JSON:API document.
      operationId: createResource
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: object
        required: true
        in: path
        description: 'The object type: a built-in entity (`person`, `company`, `deal`, …) or a custom object (`c_*`).'
        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/CreateResourceDto'
            examples:
              create:
                summary: Create a person
                value:
                  data:
                    type: person
                    attributes:
                      name:
                        first_name: Jane
                        last_name: Doe
                      email_addresses:
                        items:
                        - jane@acme.com
                      job_title: VP of Marketing
                      company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
      responses:
        '201':
          description: The created resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceResponse'
              example:
                data:
                  type: person
                  id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                  attributes:
                    _id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                    name:
                      first_name: Jane
                      last_name: Doe
                    email_addresses:
                      items:
                      - jane@acme.com
                    job_title: VP of Marketing
                    company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
                    _created_at: '2026-01-15T09:30:00.000Z'
                    _updated_at: '2026-02-01T17:45:00.000Z'
                included: []
                meta: {}
      summary: Create a resource
      tags:
      - Resources
  /workspaces/{workspace}/objects/{object}/deleted-resources:
    get:
      description: Returns a paginated JSON:API collection of the object’s recently deleted records, newest deletion first. Each resource’s `attributes` are the record’s field values as they stood at the moment of deletion, plus `_deleted_at`. Deletions older than 30 days are not returned. A record the caller could not read while it existed is not returned either. Poll incrementally with `filter[_deleted_at][Greater than]=1787273241` (epoch seconds) to read only what was deleted since your last call; `Less than` walks backwards into older deletions instead. Unlike `/resources`, this endpoint accepts neither `include` — `included` is always empty — nor `sortOrder`.
      operationId: getDeletedResources
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: object
        required: true
        in: path
        description: 'The object type: a built-in entity (`person`, `company`, `deal`, …) or a custom object (`c_*`).'
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Offset pagination, e.g. `page[offset]=0&page[limit]=100`.
        schema:
          properties:
            offset:
              default: 0
              type: number
              minimum: 0
              description: The number of records to skip before the first result.
              required: false
            limit:
              default: 50
              type: number
              minimum: 1
              maximum: 500
              description: The maximum number of records to return per page (up to 500).
              required: false
          default:
            offset: 0
            limit: 50
          type: object
      - name: filter
        required: false
        in: query
        description: Deletion-time filter, e.g. `filter[_deleted_at][Greater than]=1787273241` for everything deleted since that moment — the incremental read a polling client wants. The value is epoch seconds. Accepts `Less than`, `Less than or equal`, `Greater than`, `Greater than or equal`. `_deleted_at` is the only field that can be filtered.
        schema:
          additionalProperties:
            oneOf:
            - type: string
            - type: object
              additionalProperties:
                type: string
          type: object
      responses:
        '200':
          description: A page of recently deleted resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcesResponse'
              example:
                links:
                  next: null
                  prev: null
                meta:
                  total_records: 1
                  total_pages: 1
                  offset: 0
                  limit: 50
                data:
                - type: person
                  id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                  attributes:
                    _id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                    name:
                      first_name: Jane
                      last_name: Doe
                    email_addresses:
                      items:
                      - jane@acme.com
                    job_title: VP of Marketing
                    company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
                    _created_at: '2026-01-15T09:30:00.000Z'
                    _updated_at: '2026-02-01T17:45:00.000Z'
                    _deleted_at: '2026-02-10T12:00:00.000Z'
                  relationships: {}
                included: []
      summary: List deleted resources
      tags:
      - Resources
  /workspaces/{workspace}/objects/{object}/lists/{list}/resources:
    get:
      description: Returns a paginated JSON:API collection of the resources that belong to a specific list, applying the list’s membership on top of any `filter` you pass. Use `include` to embed related resources.
      operationId: getListResources
      parameters:
      - name: workspace
        required: true
        in: path
        description: The workspace slug — the `{slug}` segment of your Clarify workspace URL.
        schema:
          type: string
      - name: object
        required: true
        in: path
        description: 'The object type: a built-in entity (`person`, `company`, `deal`, …) or a custom object (`c_*`).'
        schema:
          type: string
      - name: list
        required: true
        in: path
        description: The unique ID of the list.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: Offset pagination, e.g. `page[offset]=0&page[limit]=100`.
        schema:
          properties:
            offset:
              default: 0
              type: number
              minimum: 0
              description: The number of records to skip before the first result.
              required: false
            limit:
              default: 500
              type: number
              minimum: 1
              maximum: 500
              description: The maximum number of records to return per page (up to 500).
              required: false
          default:
            offset: 0
            limit: 500
          type: object
      - name: sortOrder
        required: false
        in: query
        description: Sort order, e.g. `sortOrder[column]=_created_at&sortOrder[dir]=DESC`.
        schema:
          properties:
            column:
              description: The field name to sort by.
              type: string
              minLength: 1
              required: true
            dir:
              type: string
              enum:
              - ASC
              - DESC
              description: The sort direction.
              required: true
          type: object
      - name: include
        required: false
        in: query
        description: Comma-separated relationship names to embed under `relationships` and return in `included`, e.g. `include=company,deals`.
        schema:
          type: string
      - name: filter
        required: false
        in: query
        description: Nested filter object keyed by field name, e.g. `filter[status]=active` or `filter[amount][Greater than]=100`. See the endpoint description for the full operator syntax.
        schema:
          additionalProperties:
            oneOf:
            - type: string
            - type: object
              additionalProperties:
                type: string
          type: object
      responses:
        '200':
          description: A page of the list’s resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcesResponse'
              example:
                links:
                  next: null
                  prev: null
                meta:
                  total_records: 1
                  total_pages: 1
                  offset: 0
                  limit: 50
                data:
                - type: person
                  id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                  attributes:
                    _id: 5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71
                    name:
                      first_name: Jane
                      last_name: Doe
                    email_addresses:
                      items:
                      - jane@acme.com
                    job_title: VP of Marketing
                    company_id: c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88
                    _created_at: '2026-01-15T09:30:00.000Z'
                    _updated_at: '2026-02-01T17:45:00.000Z'
                included: []
      summary: List resources in a list
      tags:
      - Resources
components:
  schemas:
    ResourcesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The resource type, e.g. `person` or `deal`.
              id:
                type: string
                description: The unique ID of the resource.
              attributes:
                type: object
                additionalProperties: {}
                description: Field values keyed by field name; available fields depend on the object’s schema.
              relationships:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    data:
                      oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            description: The type of the referenced resource.
                          id:
                            type: string
                            description: The unique ID of the referenced resource.
                        required:
                        - type
                        - id
                      - type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              description: The type of the referenced resource.
                            id:
                              type: string
                              description: The unique ID of the referenced resource.
                          required:
                          - type
                          - id
                      nullable: true
                      description: A single resource reference, an array of references, or `null` when the relationship is empty.
                    meta:
                      type: object
                      properties:
                        count:
                          type: integer
                          minimum: 0
                          description: Total number of related records for a to-many relationship, independent of the number embedded in `data` (which is capped).
                      description: Metadata about the relationship.
                  required:
                  - data
                description: Related resources keyed by relationship name, present when requested via `include`.
            required:
            - type
            - id
            - attributes
          description: The page of resources.
        included:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The resource type, e.g. `person` or `deal`.
              id:
                type: string
                description: The unique ID of the resource.
              attributes:
                type: object
                additionalProperties: {}
                description: Field values keyed by field name; available fields depend on the object’s schema.
              relationships:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    data:
                      oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            description: The type of the referenced resource.
                          id:
                            type: string
                            description: The unique ID of the referenced resource.
                        required:
                        - type
                        - id
                      - type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              description: The type of the referenced resource.
                            id:
                              type: string
                              description: The unique ID of the referenced resource.
                          required:
                          - type
                          - id
                      nullable: true
                      description: A single resource reference, an array of references, or `null` when the relationship is empty.
                    meta:
                      type: object
                      properties:
                        count:
                          type: integer
                          minimum: 0
                          description: Total number of related records for a to-many relationship, independent of the number embedded in `data` (which is capped).
                      description: Metadata about the relationship.
                  required:
                  - data
                description: Related resources keyed by relationship name, present when requested via `include`.
            required:
            - type
            - id
            - attributes
          description: Related resources requested via `include`.
        meta:
          type: object
          properties:
            total_records:
              type: number
              description: Total number of records across all pages.
          description: Response metadata.
      required:
      - data
      - included
      - meta
    ResourceResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              description: The resource type, e.g. `person` or `deal`.
            id:
              type: string
              description: The unique ID of the resource.
            attributes:
              type: object
              additionalProperties: {}
              description: Field values keyed by field name; available fields depend on the object’s schema.
            relationships:
              type: object
              additionalProperties:
                type: object
                properties:
                  data:
                    oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          description: The type of the referenced resource.
                        id:
                          type: string
                          description: The unique ID of the referenced resource.
                      required:
                      - type
                      - id
                    - type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: The type of the referenced resource.
                          id:
                            type: string
                            description: The unique ID of the referenced resource.
                        required:
                        - type
                        - id
                    nullable: true
                    description: A single resource reference, an array of references, or `null` when the relationship is empty.
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        minimum: 0
                        description: Total number of related records for a to-many relationship, independent of the number embedded in `data` (which is capped).
                    description: Metadata about the relationship.
                required:
                - data
              description: Related resources keyed by relationship name, present when requested via `include`.
            meta:
              type: object
              properties:
                effective_access_level:
                  type: string
                  enum:
                  - owner
                  - edit
                  - view
                  - none
                  description: The requesting user's effective access to this record (`owner`, `edit`, `view`, or `none`).
              description: Per-request metadata about the resource.
          required:
          - type
          - id
          - attributes
          description: The resource.
        included:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The resource type, e.g. `person` or `deal`.
              id:
                type: string
                description: The unique ID of the resource.
              attributes:
                type: object
                additionalProperties: {}
                description: Field values keyed by field name; available fields depend on the object’s schema.
              relationships:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    data:
                      oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            description: The type of the referenced resource.
                          id:
                            type: string
                            description: The unique ID of the referenced resource.
                        required:
                        - type
                        - id
                      - type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              description: The type of the referenced resource.
                            id:
                              type: string
                              description: The unique ID of the referenced resource.
                          required:
                          - type
                          - id
                      nullable: true
                      description: A single resource reference, an array of references, or `null` when the relationship is empty.
                    meta:
                      type: object
                      properties:
                        count:
                          type: integer
                          minimum: 0
                          description: Total number of related records for a to-many relationship, independent of the number embedded in `data` (which is capped).
                      description: Metadata about the relationship.
                  required:
                  - data
                description: Related resources keyed by relationship name, present when requested via `include`.
            required:
            - type
            - id
            - attributes
          description: Related resources requested via `include`.
        meta:
          type: object
          properties: {}
          description: Response metadata.
      required:
      - data
      - included
      - meta
    CreateResourceDto:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              description: The resource type; matches the `object` path parameter.
            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: {}
              additionalProperties: true
            relationships:
              type: object
              additionalProperties:
                type: object
                properties:
                  data:
                    oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          description: The type of the referenced resource.
                        id:
                          type: string
                          description: The unique ID of the referenced resource.
                      required:
                      - type
                      - id
                    - type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            description: The type of the referenced resource.
                          id:
                            type: string
                            description: The unique ID of the referenced resource.
                        required:
                        - type
                        - id
                    description: The linked resource reference, or an array of references for a to-many relationship.
                required:
                - data
              description: Related resources to link on creation, keyed by relationship name.
          required:
          - type
          - attributes
          additionalProperties: false
          description: The resource to create.
      required:
      - 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>`.'