Data formats
How the REST API represents requests, responses, identifiers, dates and time zones. These conventions apply across every endpoint.
Requests and responses
Requests and responses use JSON. Send Content-Type: application/json on any request with a body, and expect JSON back.
Every request goes to your intranet's API domain over HTTPS and must include two headers:
| Header | Value |
|---|---|
Authorization |
Bearer {{access_token}} — the access token from the Quickstart token exchange. |
X-Tenant |
Your tenant GUID. See How to get API information. |
Identifiers
Resource identifiers are integers (for example a person ID, page ID or section ID). Paths that end in an identifier expect the integer form, such as GET /api/people/{id}.
Dates and times
Timestamps are ISO 8601 strings in UTC, for example:
{
"StartDate": "2026-06-06T07:38:18.503Z"
}
Always send dates in UTC. Convert to and from the user's local time in your own application.
Time zones
Where an endpoint takes a time zone, it expects a Windows time-zone name (not an IANA/Olson name). For example:
{
"TimeZone": "GMT Standard Time"
}
Booleans and enumerations
Booleans are JSON true / false. Where a field or parameter accepts a fixed set of values (an enumeration), the allowed values are listed against that parameter on the endpoint's page in the API reference.
Note: Field names in request and response bodies use the casing shown in the API reference. Send them exactly as documented.