Skip to main content
GET
Get a person's allocation window
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one person’s allocation window from startsAt to endsAt (UTC midnight epoch milliseconds, endsAt after startsAt and at most 366 days later): pod memberships, customer allocations derived from them, availability segments, the minimum cross-pod and customer-delivery availability, upcoming boundaries and any conflicts. Name the person with personId, or with workerId (one of the person’s worker seats); give exactly one, otherwise 400. Needs workforce:read at the platform scope (Console parity): a grant that covers only some org units receives 403. The person is projected as GET /api/v2/workforce/listEngineers (Engineering resourcing snapshots) projects a person: person {id, name} and workerIds, with no email, manager contexts or pod leads. A person Forge cannot resolve, or one with a membership in a pod whose managing org unit is a customer organization or sits under one, answers 404 Person not found. Too many seats, memberships or customer assignments to project in one request answers 413.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

personId
string

The person's ID. Give this or workerId, not both.

Minimum string length: 1
workerId
string

One of the person's worker seats. Give this or personId.

Minimum string length: 1
startsAt
integer
required

Inclusive window start, UTC midnight epoch milliseconds.

Required range: 0 <= x <= 9007199254740991Must be a multiple of 86400000
endsAt
integer
required

Exclusive window end, UTC midnight epoch milliseconds; after startsAt and at most 366 days later.

Required range: 0 <= x <= 9007199254740991Must be a multiple of 86400000

Response

Success

data
object
required
meta
object
required