List support contingents for a project

Retrieves all support contingents (retainer plans) configured for a specific project.

What are Support Contingents? Support contingents are retainer plans that define allocated hours and pricing for support periods. They help manage support contracts with predefined hours, rates, and transferability of unused hours.

What is returned:

All support contingents for the project, ordered by fromDate and toDate
Each contingent includes: title, date range, frequency, price, hours, calculated rate, and transferability
Date periods must not overlap within the same project

Note: Requires WsSettings.manageSettings permission.

GET/administration/project-settings/support-contingents/{projectId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

Responses

200

Support contingents retrieved successfully

Array of SupportContingentResponseDto

createdAtstringrequired

ISO 8601 timestamp when the contingent was created

frequencynumberrequired

Frequency in months for the contingent period

fromDatestringrequired

Start date of the contingent period (ISO 8601 date format)

hoursnumberrequired

Total hours allocated for the contingent period

idstringrequired

Unique identifier for the support contingent (UUID)

pricenumberrequired

Total price for the contingent period

projectIdstringrequired

ID of the project this contingent belongs to (UUID)

ratenumberrequired

Calculated hourly rate (price / hours). Automatically computed.

titlestringrequired

Title or name of the support contingent plan

toDatestring

End date of the contingent period (ISO 8601 date format). If not set, the contingent is active forever.

transferablebooleanrequired

Whether unused hours can be transferred to the next period

updatedAtstringrequired

ISO 8601 timestamp when the contingent was last updated

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*

Request

curl -X GET "https://leadtime.app/api/public/administration/project-settings/support-contingents/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/administration/project-settings/support-contingents/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/administration/project-settings/support-contingents/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "createdAt": "2024-01-15T10:00:00Z",
    "frequency": 12,
    "fromDate": "2025-01-01",
    "hours": 120,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "price": 10000,
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "rate": 83.33,
    "title": "Maintenance flatrate",
    "toDate": "2025-12-31",
    "transferable": false,
    "updatedAt": "2024-01-20T14:30:00Z"
  }
]