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

200
application/json

List of customer objects

The response is of type Customer Object · object[].