--- title: "Get all Resource allocations" method: GET path: "/1.0/resource-allocations" tags: ["Resource Allocations"] --- # Get all Resource allocations `GET /1.0/resource-allocations` ## Query parameters - `startDate` string, required - `endDate` string, required - `pageSize` number - `pageToken` string - `includeFields` string[] - `includeAllFields` boolean - `sortBy` 'startDate' | 'endDate' | 'allocationType' | 'allocationFor' - `sortOrder` 'ASC' | 'DESC' - `match` 'all' | 'any' - `memberId.eq` string - `memberId.oneOf` string - `memberId.noneOf` string - `projectId.eq` string - `projectId.oneOf` string - `projectId.noneOf` string - `placeholderId.eq` string - `placeholderId.oneOf` string - `placeholderId.noneOf` string ## Response `200` The requested action was successfully executed. - ExampleAPIResponseResourceAllocations - `data` ResourceAllocationPublicAPIResponseForExample[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response. - `startDate` string — The date when a allocation started. The format for the start date is _YYYY-MM-DD_. - `endDate` string — The date when a allocation ended. The format for the start date is _YYYY-MM-DD_. - `secondsPerDay` integer — The seconds created per day. - `minutesPerDay` integer — The minutes created per day. - `hoursPerDay` integer — The hours created per day. - `duration` ResourceAllocationTotalDurationPublicResponse — Total seconds, minutes, hours for the allocation. This is calculated for range between allocation's `startDate` and `endDate`. - `daysConsider` integer — No. of week days considered for computing the `minutes`, `hours`, `seconds`. This is calculated for range between allocation's `startDate` and `endDate`. - `seconds` integer — The total allocation seconds for entire start date and end date. - `minutes` integer — The total allocation minutes for entire start date and end date. - `hours` integer — The total allocation hours for entire start date and end date. - `allocationType` 'SOFT' | 'HARD' — Type of allocation to be made. - `allocationFor` 'TEAM_MEMBER' | 'PLACEHOLDER' — To whom allocation is for - `project` ProjectPublicAPIAllocationResponseEntity — The `project` associated with resource allocation. - `projectId` integer — The project's unique, system-generated identifier, which can be used to identify the project globally. - `projectName` string — The name of the project. - `tasks` ResourceAllocationTaskPublicAPIEntity[] — The `task(s)` associated with resource allocation. - `taskName` string — The task's unique, system-generated **identifier**, which can be used to identify the task globally. - `taskId` integer — The **name** of the task. - `member` AllocationUserPublicAPIResponseEntity — The team member associated for the allocation if chosen `allocationFor` is `TEAM_MEMBER`. - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `role` RoleResponsePublicAPI — The role of the member or placeholder to whom allocation is made for - `roleId` integer — The role's unique, system-generated identifier, which can be used to identify the role globally. - `roleName` string — The name of the role. - `placeholder` PlaceholderResponsePublicAPI — The placeholder associated for the allocation if chosen `allocationFor` is `PLACEHOLDER`. - `placeholderId` integer — The placeholder's unique, system-generated identifier, which can be used to identify the placeholder globally. - `placeholderName` string — The name of the placeholder. - `role` RoleResponsePublicAPI — The role of the member or placeholder to whom allocation is made for - `roleId` integer — The role's unique, system-generated identifier, which can be used to identify the role globally. - `roleName` string — The name of the role. - `createdAt` integer — The time when the allocation was created. The referenced time will be in epoch millis. - `updatedAt` integer — The time when the allocation was last updated. Any changes that's related to the allocation are captured and specified here in epoch millis. - `createdBy` AllocationCreatedByUserPublicAPI — The team member who created the allocation. - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `updatedBy` AllocationUpdatedByUserPublicAPI — The team member who updated the allocation - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `pagination` ExamplePaginationResourceAllocations — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages. - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank. - `hasMore` boolean — Tells us if there is more content. - `totalRecordCount` integer — Denotes the total resources matching the filters. - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page. - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes. ## Other responses - `400` — This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax. - `401` — You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab. --- [API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/revisions/1e8ba619e741/schema)