Endpoint to get a retainer for a project by id. | awork API

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

{
  "timeBudget": 72000,
  "timezone": "Europe/Berlin",
  "rollOverUnderspentBudget": true,
  "rollOverOverspentBudget": false,
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "syncProjectDates": true,
  "id": "a3f1c9d2-4b7e-4f8a-9c3d-1e2f3a4b5c6d",
  "retainerPeriod": "monthly",
  "projectId": "b7d9e8f0-1234-5678-9abc-def012345678",
  "isExternal": false,
  "retainerBudgets": [
    {
      "id": "c1d2e3f4-5678-90ab-cdef-1234567890ab",
      "timeBudget": 72000,
      "trackedDuration": 36000,
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-31T23:59:59Z"
    }
  ],
  "createdOn": "2023-12-15T10:00:00Z",
  "createdBy": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
  "updatedOn": "2024-02-01T15:30:00Z",
  "updatedBy": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70"
}

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.

retainerIdstringRequiredformat: "uuid"

The id of the retainer.

Response

timeBudgetinteger

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

timezonestring or null

The timezone for when new budgets are created.

rollOverUnderspentBudgetboolean

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

rollOverOverspentBudgetboolean

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

startDatedatetime

The start of the retainer contract.

endDatedatetime or null

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

syncProjectDatesboolean

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

idstringformat: "uuid"

The id of the retainer.

retainerPeriodstring or null

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

projectIdstringformat: "uuid"

The project this retainer is associated with.

isExternalboolean

Whether the retainer belongs to an external project.

retainerBudgetslist of objects or null

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

createdOndatetime

The date this retainer was created.

createdBystringformat: "uuid"

The id of the user who created this retainer.

updatedOndatetime

The date this retainer was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this retainer.

Errors

404

Not Found Error