Cogram Action Items API

openapi: 3.2.0
info:
  title: Cogram Action Items API
  description: 'API for integrating with Cogram. Every key is scoped to one organization.


    - **Auth**: `Authorization: Bearer `. Admins mint keys in Organization

    Settings → Integrations → API Keys.

    - **Pagination**: `page` (1-indexed) + `page_size` (default 50, max 100); returns

    `{"data": [...], "total": N, "page": N, "page_size": N}`. `total` = all matches.

    - **Errors**: `{"error": "", "message": ""}`. Branch on `error`; `message`

    wording may change.

    - **Rate limit**: per key, 1000 req/min by default. `429` carries `Retry-After`,

    `X-RateLimit-Limit`, `X-RateLimit-Remaining`.

    - **Attribution**: optional `X-Forwarded-User` header (≤200 chars) names the end user

    behind the call in Cogram''s audit trail.


    See API documentation for guides and examples.'
  version: v1
servers:
- url: /v1
tags:
- name: Action Items
  description: Read-only action items from meetings.
paths:
  /action-items:
    get:
      tags:
      - Action Items
      summary: List action items
      description: 'List action items in the organization.


        Returns a paginated list of action items belonging to the organization.

        By default, only non-archived items are returned.


        Use `project_id` to filter items from meetings linked to a specific project.

        Note: action items from meetings not linked to any project are excluded

        when filtering by project_id.


        Use `q` to search descriptions and `assignee` for partial name matching

        (both case-insensitive).


        Sorting by nullable fields (`due_date`, `assignee`, `status`, `description`)

        always places items with no value at the bottom, regardless of sort direction.


        Unknown `project_id` or `meeting_id` values return an empty list, not 404.'
      operationId: external_list_action_items_route_action_items_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed).
          default: 1
          title: Page
        description: Page number (1-indexed).
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Page Size
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - title: ActionItemStatus
            enum:
            - SUGGESTED
            - ACCEPTED
            - REJECTED
            - COMPLETED
            type: string
          - type: 'null'
          title: Status
      - name: include_archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Archived
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Matches on the source meeting's project. Items from meetings with no project are excluded.
          title: Project Id
        description: Matches on the source meeting's project. Items from meetings with no project are excluded.
      - name: meeting_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Meeting Id
      - name: assignee
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Case-insensitive partial match on assignee name.
          title: Assignee
        description: Case-insensitive partial match on assignee name.
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Case-insensitive search in `description`.
          title: Q
        description: Case-insensitive search in `description`.
      - name: sort_by
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/ActionItemSortBy'
          default: created_at
      - name: sort_dir
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          default: asc
          title: Sort Dir
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionItemListV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
components:
  schemas:
    ActionItemSortBy:
      type: string
      enum:
      - created_at
      - due_date
      - status
      - assignee
      - description
      title: ActionItemSortBy
      description: Fields that action items can be sorted by.
    ActionItemV1:
      properties:
        id:
          type: string
          title: Id
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: Assignee
          description: Free-text name, not a user reference.
        status:
          anyOf:
          - type: string
            enum:
            - SUGGESTED
            - ACCEPTED
            - REJECTED
            - COMPLETED
            title: ActionItemStatus
          - type: 'null'
          title: Status
        origin:
          anyOf:
          - type: string
            enum:
            - AUTO
            - MANUAL
            title: ActionItemOrigin
          - type: 'null'
          title: Origin
          description: '`AUTO` (AI-extracted) or `MANUAL` (user-created).'
        due_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Due Date
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        archived:
          type: boolean
          title: Archived
        meeting_id:
          type: string
          title: Meeting Id
        meeting_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Meeting Name
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Project the source meeting is filed under.
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Null if never updated.
      type: object
      required:
      - id
      - description
      - assignee
      - status
      - origin
      - due_date
      - completed_at
      - archived
      - meeting_id
      - meeting_name
      - project_id
      - created_at
      - updated_at
      title: ActionItemV1
      description: Action item response.
    ErrorCode:
      type: string
      enum:
      - api_key_missing
      - api_key_invalid_format
      - api_key_invalid
      - api_key_expired
      - bad_request
      - forbidden
      - not_found
      - method_not_allowed
      - conflict
      - validation_error
      - rate_limit_exceeded
      - internal_error
      - range_too_large
      - data_export_in_progress
      title: ErrorCode
      description: Error codes for external API v1.
    ErrorV1:
      properties:
        error:
          $ref: '#/components/schemas/ErrorCode'
          description: Stable machine-readable code. Branch on this.
        message:
          type: string
          title: Message
          description: Human-readable detail. Wording may change.
      type: object
      required:
      - error
      - message
      title: ErrorV1
      description: 'JSON body format for all API v1 error responses.


        This model controls the actual serialization of error responses:

        {"error": "not_found", "message": "Project ''xyz'' not found"}'
    ActionItemListV1:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ActionItemV1'
          type: array
          title: Data
        total:
          type: integer
          title: Total
          description: Total matches across all pages, not just this page.
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
      type: object
      required:
      - data
      - total
      - page
      - page_size
      title: ActionItemListV1
      description: Paginated action item list response.
  securitySchemes:
    HTTPBearer:
      type: http
      description: Organization API key. Minted by admins in Organization Settings → Integrations → API Keys; shown once, may carry an expiry.
      scheme: bearer
      bearerFormat: Cogram organization API key