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

# List objects

> Fetches canonical objects for a specific platform and entity type.
Each object includes the canonical (normalized) view, the raw platform data,
and a mappings array showing which platforms the entity is linked to.


Fetches all canonical objects for a specific platform and entity type. Both query parameters
are required.

Each object in the response includes:

* **`id`** - the platform's native ID (e.g., Procore's numeric ID or Dynamics' GUID)
* **`canonical_id`** - Structural's unified identifier, prefixed by entity type
  (e.g., `pay_xK9mN2vL8gM3y6P`)
* **`data`** - the canonical (normalized) view. Cross-platform-normalized shape with
  typed fields, money in minor units, and ISO currency codes
* **`platform_data`** - the raw platform payload as received from the source system
* **`mappings`** - an array listing every platform the same canonical entity is linked to.
  This is the reconciliation output: when both platforms are connected and an entity was
  matched, the array has two entries - one per platform. Consumers do not need to pair
  entities manually.

<Note>
  **Pagination.** Responses are not paginated today. The array is bounded by the seed data size
  (approximately 5-13 entities per type per platform in the demo). Pagination will be added in a
  future release.
</Note>


## OpenAPI

````yaml GET /objects
openapi: 3.1.0
info:
  title: Structural API
  version: '1.0'
  description: |
    Bidirectional data translation between construction management platforms.
    One integration gives you normalized access to every connected platform.
  contact:
    email: support@structural.app
    url: https://structural.app
servers:
  - url: https://api.structural.app/api/v1
    description: Production
security: []
paths:
  /objects:
    get:
      tags:
        - Objects
      summary: List objects
      description: >
        Fetches canonical objects for a specific platform and entity type.

        Each object includes the canonical (normalized) view, the raw platform
        data,

        and a mappings array showing which platforms the entity is linked to.
      operationId: getObjects
      parameters:
        - name: platform
          in: query
          required: true
          schema:
            type: string
            enum:
              - procore
              - dynamics
          description: The platform to fetch objects from
        - name: entity_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - project
              - customer
              - contract
              - invoice
              - payment
          description: The entity type to fetch
      responses:
        '200':
          description: Objects retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SyncEntityRow'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
      security:
        - bearerAuth: []
components:
  schemas:
    SyncEntityRow:
      type: object
      properties:
        id:
          type: string
          description: The platform's native ID for this entity
          example: '1823456'
        canonical_id:
          type: string
          description: Structural's unified identifier
          example: pay_xK9mN2vL8gM3y6P
        platform:
          type: string
          enum:
            - procore
            - dynamics
          example: procore
        entity_type:
          type: string
          example: payment
        data:
          type: object
          description: >
            The canonical (normalized) view of this entity.
            Cross-platform-normalized shape

            with typed fields, money in minor units, and ISO currency codes.
          additionalProperties: true
        platform_data:
          type: object
          description: The raw platform payload as received from the source system
          additionalProperties: true
        mappings:
          type: array
          description: >
            Every platform this canonical entity is linked to. When both
            platforms are

            connected and the entity was reconciled, this array has two entries.
          items:
            type: object
            properties:
              platform:
                type: string
                enum:
                  - procore
                  - dynamics
              platform_id:
                type: string
          example:
            - platform: procore
              platform_id: '1823456'
            - platform: dynamics
              platform_id: a34e74db-53c7-4368-8fe7-bb87c83c7902
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - message
            - request_id
          properties:
            type:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error description
              example: platform and entity_type query params required
            request_id:
              type: string
              description: Unique request identifier — quote this in support requests
              example: req_a1b2c3d4e5f6
  responses:
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: VALIDATION_ERROR
              message: Invalid input
              request_id: req_a1b2c3d4e5f6
    AuthenticationError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: AUTHENTICATION_ERROR
              message: Invalid or missing API key
              request_id: req_a1b2c3d4e5f6
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        API key passed as a Bearer token. Keys are prefixed: `sk_demo_*`
        (sandbox),

        `sk_live_*` (production), `sk_test_*` (staging).

````