Skip to main content
GET
/
objects
/
List customer objects
curl --request GET \
  --url http:localhost:3000/v2/objects/ \
  --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>",
    "customerId": "<string>",
    "name": "<string>",
    "contact": {
      "phone": "<string>",
      "email": "jsmith@example.com",
      "fax": "<string>"
    },
    "contract": {
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    },
    "objectManagerId": "<string>",
    "material": [
      {
        "articleId": "<string>",
        "budget": 123
      }
    ],
    "address": {
      "street": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "<string>"
    },
    "location": {
      "latitude": 123,
      "longitude": 123
    },
    "rating": 2.5,
    "description": "<string>",
    "securityCode": "<any>",
    "key": "<any>",
    "orderDescription": "<string>",
    "contactName": "<string>",
    "invoiceRecipientId": "<string>",
    "invoiceCCRecipientIds": [
      "<string>"
    ],
    "serviceRecipient": "<string>",
    "contactIds": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  }
]

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. name:1, number:-1)

customerId
string<objectid>[]

Filter by customer IDs

objectManagers
string<objectid>[]

Filter by Object Manager IDs

contactIds
string<objectid>[]

Filter by Contact Person IDs

nameAndAddress
string

Filter by object name or address (partial match)

name
string

Filter by name (partial match, supports full name or number)

tags
string[]

Filter by tags

active
boolean

Filter by active status

status
string

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

ids
string<objectid>[]

Filter by IDs (array of objectIds)

customerIds
string<objectid>[]

Filter by Customer IDs (returns objects for these customers)

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 customer objects

customerId
string<objectid>
required

The Customer this object belongs to

address
object
required

Physical address of the object

number
integer
required

Unique number of the entity, used for identification

name
string

Name of the customer object

contact
object

Contact information for the object

contract
object

Contract information

objectManagerId
string<objectid> | null

The user responsible for managing this object

material
object[]

Material closet items for this object

location
object

GPS coordinates of the object

rating
number

Quality rating of the object

Required range: 0 <= x <= 5
description
string

Additional description or notes

securityCode
any

Security access code for the object

key
any

Key information or access details

orderDescription
string

Order-specific description

contactName
string

Name of the contact person at the object

invoiceRecipientId
string<objectid> | null

Contact ID for invoice recipient

invoiceCCRecipientIds
string<objectid>[]

Contact IDs for invoice CC recipients

serviceRecipient
string | null

Service recipient information

contactIds
string<objectid>[]

Contact IDs associated with the object

tags
string[]

Tags associated with the object

_id
string<objectid>

Unique identifier of the entity

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