CRUD
Comments

Retrieve multiple comments by their IDs

Returns a list of comments resolved for the provided IDs.<br/> Guarantees that the array-size and order of the returned comments matches the order of requested IDs.<br/> Does not fail if any of the requested comments is not found or not accessible - instead it returns null as an array-element of the corresponding comment which could not be accessed.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/{workspaceId}/comments/list

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/{workspaceId}/comments/list
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

string[] required

Response

_embeddedItemCommentEmbed required
createdAtstring date-time required
idstring uuid required
itemIdstring uuid required
lastUpdatedAtstring date-time required

Example response

[
  {
    "content": {
      "blocks": [
        {
          "content": [
            {
              "content": "hello world",
              "type": "text"
            }
          ],
          "type": "paragraph"
        }
      ],
      "richText": true
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.