FIfieldpulse
Comments

Retrieve comments list

get/comments

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/comments
  • Auth
    API key in header x-api-key

Query parameters

limitstring

Defaults to 20 items per page, maximum 100 items allowed.

pagestring

Page number. Starts from 1, defaults to 1.

object_typestring

Get comment for the object. Values example - customer, job, project, subtasks, invoice

object_idstring

Comment object id

calculate_countstring

true or false. If true, in response will be included also total count

filterstring

Array of attribute, operator, and value parts.

sortstring

Array of attribute and order values.

relstring

array consisting of indices with the desired relation to include

Response

Successful response

errorboolean

false when the request succeeds.

total_countinteger

Total number of records that match the request, across all pages.

responseobject[]

Example response

{
  "total_count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.