Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/sites | List all sites |
| GET | /api/v1/sites/:id | Get a site by ID |
| POST | /api/v1/sites | Create a new site |
| PATCH | /api/v1/sites/:id | Update a site |
| DELETE | /api/v1/sites/:id | Delete a site |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/sites" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
name | string | Required | name |
siteNumber | string | Optional | site Number |
address | string | Required | address |
city | string | Optional | city |
state | string | Optional | state |
zipCode | string | Optional | zip Code |
region | string | Optional | region |
latitude | number | Optional | latitude |
longitude | number | Optional | longitude |
phaseId | uuid | Optional | phase Id Related resource: |
status | enum | Optional | status Values: |
score | number | Optional | score |
acquisitionType | enum | Optional | acquisition Type Values: |
projectType | string | Optional | project Type |
projectStartDate | datetime | Optional | project Start Date |
targetOpeningDate | datetime | Optional | target Opening Date |
demographics | json | Optional | demographics |
financials | json | Optional | financials |
details | json | Optional | details |
landlordContactId | uuid | Optional | landlord Contact Id |
sourceDealId | uuid | Optional | source Deal Id Related resource: |
dealTransferNotes | string | Optional | deal Transfer Notes |
dealTransferredAt | datetime | Optional | deal Transferred At |
credentialcampLocationId | uuid | Optional | credentialcamp Location Id |
smartshiftsLocationId | uuid | Optional | smartshifts Location Id |
quipassistLocationId | uuid | Optional | quipassist Location Id |
incidentvaultLocationId | uuid | Optional | incidentvault Location Id |
policytrakLocationId | uuid | Optional | policytrak Location Id |
leasecommandLocationId | uuid | Optional | leasecommand Location Id |
lastAppliedPurchaseTemplateId | uuid | Optional | last Applied Purchase Template Id |
lastAppliedPurchaseTemplateAt | datetime | Optional | last Applied Purchase Template At |
projectLeadId | uuid | Optional | project Lead Id |
classification | enum | Optional | classification Values: |
createdAt | datetime | Optional | Creation timestamp (auto) |
updatedAt | datetime | Optional | Last update timestamp (auto) |