List project phases
Retrieves all project phases (sales pipeline stages) configured for the workspace.
What are Project Phases? Project phases map out the steps a project or lead goes through in the sales process. They are used in the integrated Sales CRM and can be customized to match your sales workflow.
Default phase types include:
- Not contacted: Lead has not been approached yet
- Research: Information is being gathered about the lead
- Contact made: Lead has been reached
- Reminder: A follow-up is planned
- Not reached: Could not get in touch with the lead
- Implementation: Project is confirmed and executed
Phase type values:
- new: Initial/starting phase
- inProgress: Active work phase
- done: Completed/closed phase
What is returned:
- Phase ID, name, icon, type, and description
- Sort order (for display ordering)
- Multilingual translations
Note: Phases affect the lanes in the Sales Kanban board. The phase type determines which section of the pipeline the opportunity appears in.
GET
/administration/project-settings/phasesAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredResponses
200Project phases retrieved successfully
Array of
ProjectPhaseResponseDtodescriptionobjectOptional description providing context about when to use this phase.
iconstringrequiredIcon identifier in emoji format (e.g., ":calendar:"). Displayed next to the phase name throughout the application.
idstringrequiredUnique identifier (UUID) for the project phase. Used to reference this phase when creating or updating opportunities.
namestringrequiredDisplay name of the project phase. Shown in dropdowns and the Sales Kanban board.
sortnumberNumeric sort order for display purposes. Lower numbers appear first in lists and dropdowns. May be undefined if not explicitly set.
translationsProjectPhaseTranslationDto[]requiredComplete array of translations for all supported languages. Each translation contains the language code and localized name/description.
Show propertiesHide properties
Array of
ProjectPhaseTranslationDtodescriptionobjectTranslated description of the project phase in this language. Provides context about when to use this phase.
languagestringrequiredISO 639-1 language code for the translation (e.g., "en" for English, "de" for German)
nameobjectTranslated name of the project phase in this language. Used for multilingual display in the user interface.
typestringrequiredPhase type enum value that determines which Kanban column the opportunity appears in. Valid values: new, inProgress, done.
Allowed:
newinProgressdone401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/administration/project-settings/phases" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"const response = await fetch("https://leadtime.app/api/public/administration/project-settings/phases", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
});import requests
response = requests.get(
"https://leadtime.app/api/public/administration/project-settings/phases",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
},
)Response
[
{
"description": "Initial planning and requirement gathering phase",
"icon": ":calendar:",
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Planning",
"sort": 1,
"translations": [
{
"description": "Project planning phase",
"language": "en",
"name": "Planning"
},
{
"description": "Projektplanungsphase",
"language": "de",
"name": "Planung"
}
],
"type": "new"
}
]Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions