Comments API

Comments use cursor pagination, like every list in the API. Read the next page with the cursor from the previous response.

Details

All requests are made over HTTPS to the base path /api/v1, and every response is JSON.
Send Content-Type: application/json on requests that have a body.
Each response includes a request_id; quote it when you contact support.
Timestamps are ISO 8601 in UTC, and identifiers are opaque strings.
Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate.
Rate limits are per workspace per minute, and the response headers show how many requests remain.
The SDKs for TypeScript, Python and Go wrap these calls and handle pagination for you.
Fields not listed on this page are ignored on write and may be added to responses later.
All requests are made over HTTPS to the base path /api/v1, and every response is JSON. (Comments API, note 2.)
Send Content-Type: application/json on requests that have a body. (Comments API, note 2.)
Each response includes a request_id; quote it when you contact support. (Comments API, note 2.)
Timestamps are ISO 8601 in UTC, and identifiers are opaque strings. (Comments API, note 2.)
Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate. (Comments API, note 2.)
Rate limits are per workspace per minute, and the response headers show how many requests remain. (Comments API, note 2.)

Every plan includes the Stackly API, so the steps on this page work on Free, Pro and Business.