Endpoint to get all retainers for a project.

GET

https://api.awork.com/api/v1/projects/:projectId/retainers

GET

/api/v1/projects/:projectId/retainers

$ curl https://api.awork.com/api/v1/projects/projectId/retainers \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "timeBudget": 72000,
4     "timezone": "Europe/Berlin",
5     "rollOverUnderspentBudget": true,
6     "rollOverOverspentBudget": false,
7     "startDate": "2024-01-01T00:00:00Z",
8     "endDate": "2024-12-31T23:59:59Z",
9     "syncProjectDates": true,
10     "id": "a3f47c9e-8b2d-4f3a-9c1e-2d5f7b8a9c3e",
11     "retainerPeriod": "monthly",
12     "projectId": "b7d9f1a2-4c3e-4d5f-8a9b-7c6e5d4f3a2b",
13     "isExternal": false,
14     "retainerBudgets": [
15       {
16         "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
17         "timeBudget": 7200,
18         "trackedDuration": 5400,
19         "startDate": "2024-01-01T00:00:00Z",
20         "endDate": "2024-01-31T23:59:59Z"
21       }
22     ],
23     "createdOn": "2023-12-15T10:00:00Z",
24     "createdBy": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
25     "updatedOn": "2024-02-01T08:30:00Z",
26     "updatedBy": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a"
27   }
28 ]

The user must have the ProjectMasterData read permission for the project to access this endpoint.

Required Permissions

Any authenticated user.

The user must have the ProjectMasterData read permission for the project to access this endpoint. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

The id of the project.

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

timeBudgetintegerOptional

The time budget per retainer period in seconds. The default budget amount for new budgets in this retainer.

timezonestring or nullOptional

The timezone for when new budgets are created.

rollOverUnderspentBudgetbooleanOptional

Whether underspent budgets should be rolled over to the next period.

rollOverOverspentBudgetbooleanOptional

Whether overspent budgets should be rolled over to the next period.

startDatestringOptionalformat: "date-time"

The start of the retainer contract.

endDatestring or nullOptionalformat: "date-time"

The end of the retainer contract until new budgets will be created. Optional.

syncProjectDatesbooleanOptional

Whether the project start and due dates should be synced to the retainer start and end dates.

idstringOptionalformat: "uuid"

The id of the retainer.

retainerPeriodstring or nullOptional

The period for new budgets in this retainer. Currently only 'monthly' is supported.

projectIdstringOptionalformat: "uuid"

The project this retainer is associated with.

isExternalbooleanOptional

Whether the retainer belongs to an external project.

retainerBudgetslist of objects or nullOptional

The budgets for this retainer. Each budget period (month) gets its own budget.

createdOnstringOptionalformat: "date-time"

The date this retainer was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this retainer.

updatedOnstringOptionalformat: "date-time"

The date this retainer was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this retainer.