# Returns a list of allocations.

`GET /psa/allocations`

Group: PSA › Allocations · Operation ID: `allocations`

The memberId, employeeId, projectActivityId, projectPositionId and psaProjectId on an allocation are numeric package-layer keys, not the UUIDs the public GET endpoints take, so none of them can be followed over this API. Allocations cannot be matched by member, project or activity: those fields are returned but are not filters, and there is no search endpoint, so what a person is allocated to cannot be answered over this API.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=allocations)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"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`. |

## Query surface

- `startDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `endDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `method` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `lastModifiedDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- Orderable: startDate, endDate, totalHours, method, lastModifiedDate
- Selectable: id, startDate, endDate, totalHours, notes, method, memberId, employeeId, projectActivityId, projectPositionId, psaProjectId, memberName, memberPlaceholderName, projectActivityName, projectPositionName, lastModifiedDate

## Response

`200` Success

Under `data`, an array of allocationsRow:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The unique identifier for the allocation. |
| `startDate` | string (date) | no | The first day of the allocation period, inclusive. Format YYYY-MM-DD. |
| `endDate` | string (date) | no | The last day of the allocation period, inclusive. Format YYYY-MM-DD. |
| `totalHours` | string (decimal) | no | The total planned hours for the allocation period. |
| `notes` | string or null | no | Free-form notes about the allocation. |
| `method` | string | no | The distribution method for the planned hours. Possible values: 'totalHours', 'hoursPerDay', 'hoursPerWeek', 'hoursPerMonth'. |
| `memberId` | number or null | no | The id of the PSA team-member assignment the allocation is booked against. It is a numeric package-layer key, not the UUID that GET psa/team-members/:id takes. |
| `employeeId` | number or null | no | The id of the employee for the allocated team member. It is a numeric package-layer key, and there is no public endpoint for an employee. |
| `projectActivityId` | number or null | no | The id of the project activity the allocation is against. It is a numeric package-layer key, not the UUID that GET psa/activities/:id takes. |
| `projectPositionId` | number or null | no | The id of the project position the allocation is against. It is a numeric package-layer key, not the UUID that GET psa/positions/:id takes. |
| `psaProjectId` | number | no | The id of the PSA project the allocation belongs to. It is a numeric package-layer key, not the UUID that GET psa/projects/:id takes. |
| `memberName` | string or null | no | The name of the allocated team member. |
| `memberPlaceholderName` | string or null | no | The name of the placeholder, when the allocation is to a placeholder rather than an employee. |
| `projectActivityName` | string or null | no | The name of the project activity. |
| `projectPositionName` | string or null | no | The name of the project position. |
| `lastModifiedDate` | string (date-time) or null | no | The date and time the allocation record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |

## Statuses

- `400` — Invalid request or business failure
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error