> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pland.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Object

> Retrieve detailed information about a specific customer object by its unique identifier.



## OpenAPI

````yaml GET /objects/{id}
openapi: 3.0.0
info:
  title: PlanD API
  description: PlanD Public API
  version: '2'
servers:
  - url: http:localhost:3000/v2
    description: Local Server
  - url: https://beta-api.pland.app/v2
    description: Sandbox Server
  - url: https://cloud-api.pland.app/v2
    description: Production Server
security: []
tags:
  - name: Absences
    description: >-
      Absence management endpoints for creating, updating, and managing user
      absences
  - name: Activity Types
    description: Activity type management operations
  - name: API Keys
    description: API key management operations for programmatic access to the API
  - name: Assignments
    description: Assignment management operations
  - name: Chat (Legacy)
    description: >-
      Legacy chat operations using Stream Chat service (deprecated - use Entity
      Chat v2 instead)
  - name: Client
    description: Unauthenticated client-facing operations
  - name: Company
    description: Company information and settings management operations
  - name: Complaints
    description: Customer complaint and ticket management operations
  - name: Contacts
    description: Contact person management operations
  - name: Customers
    description: Customer management operations
  - name: Customer Objects
    description: >-
      Customer object management operations - locations and buildings where
      services are performed
  - name: Documents
    description: >-
      Document management operations for uploading, retrieving, and managing
      files
  - name: Logbuch
    description: >-
      Operations for sending, retrieving, updating, and deleting Logbuch in
      entity chats.
  - name: Push Notifications
    description: Operations for listing, reading, and deleting user notifications.
  - name: Equipment
    description: Equipment management operations
  - name: Equipment Types
    description: Equipment type management operations
  - name: Assignment Confirmations
    description: Assignment confirmation management operations
  - name: Credit
    description: >-
      Credit note management operations for creating and handling credit
      documents
  - name: Invoice
    description: >-
      Invoice management operations for creating, managing, and processing
      customer invoices
  - name: Invoice Reminders
    description: >-
      Invoice reminder management operations for creating and handling payment
      reminder documents
  - name: Invoice Reminder Templates
    description: >-
      Invoice reminder template management operations for creating and handling
      reminder document templates
  - name: Invoice Storno
    description: Invoice storno (cancellation) document management operations
  - name: Invoice Templates
    description: >-
      Invoice template management operations for creating and handling invoice
      document templates
  - name: Offers
    description: Offer management operations
  - name: ServiceReport
    description: >-
      Service report management operations for creating and handling service
      documentation
  - name: Holiday
    description: Holidays management
  - name: Implementation
    description: User implementation progress tracking and onboarding management
  - name: Jobs
    description: >-
      Endpoints for managing jobs, including creation, listing, updating, and
      job-specific actions.
  - name: Material Orders
    description: Operations for listing, viewing, updating, and managing material orders.
  - name: Notifications
    description: User notification management operations
  - name: Payment Methods
    description: >-
      Payment method management operations for configuring available payment
      options
  - name: Payment Terms
    description: Operations for managing payment terms
  - name: Payments
    description: Payment management operations
  - name: Articles
    description: >-
      Operations for creating, listing, viewing, updating, and deleting
      articles.
  - name: Suppliers
    description: Supplier management operations
  - name: Service Products
    description: >-
      Operations for creating, listing, viewing, updating, and deleting service
      products.
  - name: Quality Control
    description: Quality control and assessment management operations
  - name: Pay Types
    description: Pay type management operations for salary and absence types
  - name: Salary
    description: >-
      Salary management operations for tracking and managing employee
      compensation
  - name: Surcharges
    description: Surcharge management operations for pay types and salary calculations
  - name: Search
    description: Search for entities in PlanD
  - name: Signing
    description: Endpoints for creating and listing signings (digital signatures).
  - name: Tasks
    description: Task management operations
  - name: Task Types
    description: Task type management operations
  - name: Tax Rates
    description: >-
      Tax rate management operations for handling VAT, zero rates, exemptions,
      and reverse charge scenarios
  - name: Time Tracking
    description: >-
      Time tracking management endpoints for recording, monitoring, and managing
      work time entries
  - name: Assets
    description: Asset URL management operations for secure access to uploaded files
  - name: Upload
    description: >-
      CSV and file uploads for various entities (articles, material, users,
      customers, objects, contacts, equipment, images)
  - name: Users
    description: >-
      User management endpoints for creating, updating, and managing system
      users
  - name: Authentication
    description: User authentication and password management operations
  - name: Banking Transactions
    description: Banking transaction management operations
  - name: Webhooks
  - name: SMS
    description: Endpoints for SMS status updates and link tracking.
paths:
  /objects/{id}:
    get:
      tags:
        - Customer Objects
      summary: Get customer object by ID
      description: >-
        Retrieve detailed information about a specific customer object by its
        unique identifier.
      operationId: getCustomerObject
      parameters:
        - name: id
          in: path
          description: Unique identifier of the customer object to retrieve
          required: true
          schema:
            type: string
            format: objectid
            example: 507f1f77bcf86cd799439011
      responses:
        '200':
          description: Customer object retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerObject'
        '401':
          description: Authentication required - invalid or missing authentication token
        '403':
          description: >-
            Access forbidden - insufficient permissions to view this customer
            object
        '404':
          description: Customer object not found with the specified ID
components:
  schemas:
    CustomerObject:
      title: Customer Object
      description: >-
        A customer object represents a location or building where services are
        performed
      required:
        - customerId
        - number
        - address
      type: object
      allOf:
        - $ref: '#/components/schemas/ChatableEntityModel'
        - properties:
            customerId:
              description: The Customer this object belongs to
              type: string
              format: objectid
            name:
              description: Name of the customer object
              type: string
            contact:
              description: Contact information for the object
              properties:
                phone:
                  type: string
                email:
                  type: string
                  format: email
                fax:
                  type: string
              type: object
            contract:
              description: Contract information
              properties:
                startDate:
                  type: string
                  format: date-time
                endDate:
                  type: string
                  format: date-time
              type: object
            objectManagerId:
              description: The user responsible for managing this object
              type: string
              format: objectid
              nullable: true
            material:
              description: Material closet items for this object
              type: array
              items:
                properties:
                  articleId:
                    description: MaterialClosetItem[]
                    type: string
                    format: objectid
                  budget:
                    description: MaterialClosetItem[]
                    type: number
                    format: float
                type: object
            address:
              description: Physical address of the object
              properties:
                street:
                  type: string
                zip:
                  type: string
                city:
                  type: string
                country:
                  type: string
              type: object
            location:
              description: GPS coordinates of the object
              properties:
                latitude:
                  type: number
                  format: float
                longitude:
                  type: number
                  format: float
              type: object
            rating:
              description: Quality rating of the object
              type: number
              format: float
              maximum: 5
              minimum: 0
            description:
              description: Additional description or notes
              type: string
            securityCode:
              description: Security access code for the object
            key:
              description: Key information or access details
            orderDescription:
              description: Order-specific description
              type: string
            contactName:
              description: Name of the contact person at the object
              type: string
            invoiceRecipientId:
              description: Contact ID for invoice recipient
              type: string
              format: objectid
              nullable: true
            invoiceCCRecipientIds:
              description: Contact IDs for invoice CC recipients
              type: array
              items:
                type: string
                format: objectid
            serviceRecipient:
              description: Service recipient information
              type: string
              nullable: true
            contactIds:
              description: Contact IDs associated with the object
              type: array
              items:
                type: string
                format: objectid
            tags:
              description: Tags associated with the object
              type: array
              items:
                type: string
          type: object
    ChatableEntityModel:
      title: Chatable Entity Model
      description: Base class for all entities that can have a chat associated with them.
      type: object
      allOf:
        - $ref: '#/components/schemas/Entity'
        - properties:
            chatId:
              description: ID of the chat associated with this entity
              type: string
              format: objectid
              nullable: true
          type: object
    Entity:
      title: Entity
      description: >-
        Base class for all entities in the system, providing common properties
        and methods.
      properties:
        _id:
          description: Unique identifier of the entity
          type: string
          format: objectid
        number:
          description: Unique number of the entity, used for identification
          type: integer
        companyId:
          description: The ID of the company this entity belongs to
          type: string
          format: objectid
          x-internal: true
        status:
          $ref: '#/components/schemas/StatusStruct'
      type: object
    StatusStruct:
      description: Entity Status information
      properties:
        status:
          description: Current status
          type: integer
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
        createdBy:
          description: User who created this supplier
          type: string
          format: objectid
        lastModifiedAt:
          description: Last modification timestamp
          type: string
          format: date-time
        lastModifiedBy:
          description: User who last modified this supplier
          type: string
          format: objectid
      type: object

````