GET /v1/comments

Family: Lists and collaboration · Operation ID: v1_list_comments

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open lists

Required scope: lists or bulk, based on the linked resource

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X GET "$API_BASE_URL/v1/comments" \
  -H "Authorization: Bearer $API_KEY"

Parameters

[
  {
    "in": "query",
    "name": "job_id",
    "required": false,
    "schema": {
      "format": "int32",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "list_id",
    "required": false,
    "schema": {
      "format": "int32",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "limit",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "offset",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  }
]

Responses

{
  "description": "Comments list"
}

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract