OFofficernd
Comments

Retrieve comments

Retrieve a paginated list of comments for a single target type. Use target and targetType in each result to match comments to their entity.

Required scopes: flex.community.comments.read

get/api/v2/organizations/{orgSlug}/comments

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/comments
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.community.comments.read

Path parameters

orgSlugstring required

organization slug

Query parameters

$cursorNextstring
$cursorPrevstring
$limitnumber
targetType'payment' | 'member' | 'company' required

The type of the entity the comment is on.

The type of the entity the comments are on. Invoices, credit notes and overpayments are all payment.

Response

rangeStartnumber
rangeEndnumber
cursorNextstring
cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6ae8841ec1df3a983690798a",
      "text": "This is the comment text",
      "target": "6ae8841ec1df3a983690798b",
      "member": "6ae8841ec1df3a983690798c",
      "createdAt": "2024-04-12T00:00:00.000Z",
      "createdBy": "6080186f490fcf6e0537ec27",
      "modifiedAt": "2024-05-12T00:00:00.000Z",
      "modifiedBy": "6080186f490fcf6e0537ec54"
    }
  ]
}

Changes

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