Skip to main content
GET
/
objects
List objects
curl --request GET \
  --url https://api.structural.app/api/v1/objects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1823456",
      "canonical_id": "pay_xK9mN2vL8gM3y6P",
      "platform": "procore",
      "entity_type": "payment",
      "data": {},
      "platform_data": {},
      "mappings": [
        {
          "platform": "procore",
          "platform_id": "1823456"
        },
        {
          "platform": "dynamics",
          "platform_id": "a34e74db-53c7-4368-8fe7-bb87c83c7902"
        }
      ]
    }
  ]
}
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.
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.

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token. Keys are prefixed: sk_demo_* (sandbox), sk_live_* (production), sk_test_* (staging).

Query Parameters

​
platform
enum<string>
required

The platform to fetch objects from

Available options:
procore,
dynamics
​
entity_type
enum<string>
required

The entity type to fetch

Available options:
project,
customer,
contract,
invoice,
payment

Response

Objects retrieved

​
data
object[]