Access and authentication
Ask your company administrator for an approved API key and the API base URL assigned to your company. The key’s company, project and module permissions apply to every export, along with your subscription’s access limits.
Send the key in the authorization header. Keep it on your server or in your integration’s secret store, away from browser code, URLs and shared examples.
Authorization: Bearer <YOUR_API_KEY>A documentation link does not grant access to company records. Use a key issued for the company and purpose you are working with.
Reference operations
The OpenAPI reference covers these three GET operations. Health returns service metadata; projects and locations require a company-scoped key with reference export access.
| Path | Use |
|---|---|
/api/v1/export/health | Check service metadata. No company records are returned. |
/api/v1/export/projects | Read the projects available to your approved key. |
/api/v1/export/locations | Read locations within the key’s company and project scope. |
Use your assigned base URL in requests. This example shows the request format; replace the values in angle brackets in your own secure environment.
curl "<YOUR_ASSIGNED_API_BASE>/api/v1/export/projects?page=1&pageSize=100" \
-H "Authorization: Bearer <YOUR_API_KEY>"This reference covers a subset of the outgoing API. It does not describe private administration endpoints or promise a Schedule activity/WBS API, write API, CLI, SDK or MCP service.
Pagination and updates
Start with page=1 and pageSize=100. The maximum page size is 500. Read pagination.hasMore in the response and increase the page number until it is false.
Projects and locations also accept updatedSince as an ISO 8601 timestamp, so you can filter subsequent exports to updated records.
| Field | What it contains |
|---|---|
data | The records returned for this page. |
pagination | The current page, page size and whether another page is available. |
meta | The authorized company scope, export time, endpoint and row count. |
Errors and limits
Export errors return JSON with error, code and status. Use the status and code to decide what needs to change before the next request.
| Status | Next step |
|---|---|
| 400 | Check the query parameters and correct the invalid values. |
| 401 | Check for a missing, invalid, expired or revoked key. |
| 403 | Ask your administrator to review the key’s permitted scope. |
| 402 or 423 | Review the company’s subscription access with its administrator. |
| 429 | Wait for the rate limit or quota to reset before trying again. |
| 500 | If the error persists, contact support with the error code and time, without including keys or company records. |
The default limit is 90 requests per minute per key, with a separate daily quota. Follow Retry-After or the reset headers returned by your request. A daily quota may require a longer wait; avoid an automatic retry loop.
Working with company data
Keep exported records and response metadata within the purpose your company approved. Do not place keys or records in public logs, AI prompts or shared examples.
Outgoing exports are read-only. They do not save or approve records, upload files, send notifications, accept agreements, run AI models or start payments.
Need help planning an integration? Talk to SiteAxis. For a concise guide to the product and available resources, see llms.txt.