retainers

Returns the specified project retainer.

Changed on

Returns the specified retainer for the project. <Check title="Required Permissions" icon="key">The user must have project-master-data:read permission for the project.</Check>

get/projects/{projectId}/retainers/{retainerId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projects/{projectId}/retainers/{retainerId}
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

The id of the project.

retainerIdstring uuid required

The id of the retainer.

Response

OK

timeBudgetinteger

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

timezonestring nullable

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.

startDatestring date-time

The start of the retainer contract.

endDatestring date-time nullable

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.

idstring uuid

The id of the retainer.

retainerPeriodstring nullable

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

projectIdstring uuid

The project this retainer is associated with.

isExternalboolean

Whether the retainer belongs to an external project.

createdOnstring date-time

The date this retainer was created.

createdBystring uuid

The id of the user who created this retainer.

updatedOnstring date-time

The date this retainer was last modified.

updatedBystring uuid

The id of the user who last modified this retainer.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetProjectRetainerByProjectIdAndRetainerId removed and replaced with retainers_GetProjectRetainerByProjectIdAndRetainerId