Skip to main content
GET
/
complaints
List complaints
curl --request GET \
  --url http://localhost:3000/v2/complaints/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "desc": "Updated complaint description with additional details",
    "roomDescription": "Updated room location information",
    "contactName": "John Smith Jr.",
    "contact": {
      "email": "[email protected]",
      "telephone": "<string>"
    },
    "priority": 3,
    "images": [
      "<string>"
    ],
    "userId": "507f1f77bcf86cd799439014",
    "comment": "Additional notes about the complaint resolution",
    "response": "Thank you for your patience. The issue has been resolved.",
    "customFields": {}
  }
]

Authorizations

​
x-API-Key
string
header
required

Query Parameters

​
limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
​
sort
string

Sort field and direction (e.g. number:1, status.createdAt:-1)

Example:

"number:1"

​
status
string

Filter by status (single value or comma-separated list)

​
ids
string<objectid>[]

Filter by IDs (array of objectIds)

​
objectIds
string<objectid>[]

Filter by object IDs

​
object
string<objectid>

Filter by object ID

​
customerIds
string<objectid>[]

Filter by Customer IDs (returns objects for these customers)

​
objectManager
string<objectid>

Filter by object manager user ID

​
objectManagers
string<objectid>[]

Filter by Object Manager IDs

​
objectsByName
object

Filter something (e.g. complaints) by the objects name or number

​
userIds
string<objectId>[]

Filter to search jobs by user IDs. If the user ID is "unassigned_jobs", it will search for jobs without a user ID.

User ID to filter jobs by. If "unassigned_jobs" is included, it will also search for jobs without a user ID.

​
user
string<objectid>

Filter by user ID

​
complaintStatus
enum<string>

Filter complaints by their current status

Available options:
new,
assigned,
finished
​
from
integer<int64>

Filter by creation date from (timestamp)

​
to
integer<int64>

Filter by creation date to (timestamp)

​
searchComplaint
string

Search complaints by text content

​
generalField
object

A dynamic filter that allows filtering on any field with various operators. Supports string, number, boolean, date, and objectid field types.

Response

List of complaints

​
_id
string<objectid>

Unique identifier of the entity

​
number
integer

Unique number of the entity, used for identification

​
companyId
string<objectid>

The ID of the company this entity belongs to

​
status
object

Entity Status information

​
chatId
string<objectid> | null

ID of the chat associated with this entity

​
desc
string

Updated description of the complaint

Example:

"Updated complaint description with additional details"

​
roomDescription
string

Updated room description

Example:

"Updated room location information"

​
contactName
string

Updated contact name

Example:

"John Smith Jr."

​
contact
object

Updated contact information

​
priority
integer

Updated priority level (1=Low, 2=Medium, 3=High, 4=Critical)

Required range: 1 <= x <= 4
Example:

3

​
images
string<uri>[]

Updated images for the complaint

​
userId
string<objectid> | null

ID of the user to assign/reassign this complaint to

Example:

"507f1f77bcf86cd799439014"

​
comment
string

Internal comment about the complaint

Example:

"Additional notes about the complaint resolution"

​
response
string

Customer response message

Example:

"Thank you for your patience. The issue has been resolved."

​
customFields
object

Updated custom field values