Skip to main content
POST
/
connect
Connect a platform
curl --request POST \
  --url https://api.structural.app/api/v1/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "data": {
    "platform": "procore",
    "status": "connected",
    "entities": {
      "projects": 5,
      "customers": 4,
      "contracts": 13,
      "invoices": 8,
      "payments": 8
    }
  }
}
Seeds all entity types (projects, customers, contracts, invoices, payments) for the specified platform. When connecting the second platform, Structural automatically reconciles entities against the first platform’s data using business keys - check numbers, invoice numbers, contract numbers. The response includes a count of seeded entities per type so you can verify the connection succeeded.
Destructive re-seed. Calling /connect on a platform that is already connected deletes all existing data for that platform - entity mappings, canonical objects, and platform objects - before re-seeding from scratch. Any changes made via /propagate since the last connect are lost. This is a reset, not an idempotent update.
After connecting, use GET /connections to verify the platform is active, then GET /objects to read the reconciled data.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
platform
enum<string>
required

The platform to connect

Available options:
procore,
dynamics

Response

Platform connected successfully

​
data
object