Clarifymedical List Rows API

openapi: 3.2.0
info:
  title: Clarify List Rows API
  description: The Clarify API OpenAPI documentation
  version: '0.1'
  contact: {}
servers:
- url: https://api.clarify.ai/v1
security:
- apiKey: []
- bearer: []
tags:
- name: ListRows
paths:
  /workspaces/{workspace}/objects/{object}/lists/{list}/rows/csv:
    post:
      description: Streams the rows of a list as a `text/csv` file download. The first row is a header of field names. Pass a `sql` statement in the body to export a custom query instead of the list’s own rows.
      operationId: getListRowsCsv
      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: 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/ListOfRowsRequestDto'
            examples:
              export:
                summary: Export the list’s rows
                value:
                  sql: SELECT * FROM deal WHERE amount >= 50000
      responses:
        '200':
          description: The list rows as a CSV file.
          content:
            text/csv:
              schema:
                type: string
                format: binary
              example: '_id,name,stage,amount,close_date

                e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42,Acme Renewal Q1,In progress,50000,2026-03-31'
      summary: Export a list’s rows as CSV
      tags:
      - ListRows
components:
  schemas:
    ListOfRowsRequestDto:
      type: object
      properties:
        sql:
          type: string
          description: Overrides the list’s own query with a custom SQL statement selecting the rows to export. Defaults to the list’s query.
        search:
          type: object
          properties:
            query:
              type: string
              description: Case- and accent-insensitive match on each row’s name and identifier fields. Every word must match; the last word matches as a prefix.
          description: Full-text search applied on top of the list’s rows.
  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>`.'