Skip to main content
GET
Get customer object by ID

Path Parameters

id
string<objectid>
required

Unique identifier of the customer object to retrieve

Example:

"507f1f77bcf86cd799439011"

Response

Customer object retrieved successfully

A customer object represents a location or building where services are performed

number
integer
required

Unique number of the entity, used for identification

customerId
string<objectid>
required

The Customer this object belongs to

address
object
required

Physical address of 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

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<float>

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