Retrieve an allocation

Operation ID: getAllocation

Group: PSA › Allocations

Open in the interactive reference

GET /psa/allocations/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an allocation. The ids that link an allocation to other records (memberId, employeeId, projectActivityId, projectPositionId, and psaProjectId) are numeric, not UUIDs. You can't use them with the GET endpoints for team members, activities, positions, or projects.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier of the allocation you want to retrieve. Example: "6f3c1f0e-6a2b-4d5e-9c11-2b7a8e4d0f13".

Response

200 Success

Under data (getAllocationOutput):

Field Type Required Description
id string yes The unique identifier for the allocation. Example: "6f3c1f0e-6a2b-4d5e-9c11-2b7a8e4d0f13".
startDate date yes The first day of the allocation period, inclusive. Format YYYY-MM-DD. Example: "2026-08-03".
endDate date yes The last day of the allocation period, inclusive. Format YYYY-MM-DD. Example: "2026-08-14".
totalHours decimal yes The total planned hours for the allocation period. Example: "40.00".
notes string no Free-form notes about the allocation.
method string yes The distribution method for the planned hours. Possible values: 'totalHours', 'hoursPerDay', 'hoursPerWeek', 'hoursPerMonth'. Example: "totalHours".
memberId number no The id of the PSA team-member assignment the allocation is booked against. It is a numeric key, not the UUID that GET psa/team-members/:id takes.
employeeId number no The id of the employee for the allocated team member. It is a numeric key, and there is no public endpoint for an employee.
projectActivityId number no The id of the project activity the allocation is against. It is a numeric key, not the UUID that GET psa/activities/:id takes.
projectPositionId number no The id of the project position the allocation is against. It is a numeric key, not the UUID that GET psa/positions/:id takes.
psaProjectId number yes The id of the PSA project the allocation belongs to. It is a numeric key, not the UUID that GET psa/projects/:id takes. Example: 32341.
memberName string no The name of the allocated team member.
memberPlaceholderName string no The name of the placeholder, when the allocation is to a placeholder rather than an employee.
projectActivityName string no The name of the project activity.
projectPositionName string no The name of the project position.
lastModifiedDate date-time yes The date and time the allocation record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-14T09:12:33.421Z". 
{
  "data": {
    "id": "6f3c1f0e-6a2b-4d5e-9c11-2b7a8e4d0f13",
    "startDate": "2026-08-03",
    "endDate": "2026-08-14",
    "totalHours": "40.00",
    "notes": "<notes>",
    "method": "totalHours",
    "memberId": 0,
    "employeeId": 0,
    "projectActivityId": 0,
    "projectPositionId": 0,
    "psaProjectId": 32341,
    "memberName": "<memberName>",
    "memberPlaceholderName": "<memberPlaceholderName>",
    "projectActivityName": "<projectActivityName>",
    "projectPositionName": "<projectPositionName>",
    "lastModifiedDate": "2026-08-14T09:12:33.421Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses