Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

Get project phase details

Retrieves detailed information about a specific project phase by its ID.

What is returned:

  • Phase ID, name, icon, type, and description
  • Sort order
  • Complete translations array with all language variants

Use cases:

  • Display phase details in a form
  • Verify phase exists before updating
  • Retrieve full translation set for editing
GET/administration/project-settings/phases/{id}
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstringrequired
Responses
200Project phase retrieved successfully
descriptionobject
Optional description providing context about when to use this phase.
iconstringrequired
Icon identifier in emoji format (e.g., ":calendar:"). Displayed next to the phase name throughout the application.
idstringrequired
Unique identifier (UUID) for the project phase. Used to reference this phase when creating or updating opportunities.
namestringrequired
Display name of the project phase. Shown in dropdowns and the Sales Kanban board.
sortnumber
Numeric sort order for display purposes. Lower numbers appear first in lists and dropdowns. May be undefined if not explicitly set.
translationsProjectPhaseTranslationDto[]required
Complete array of translations for all supported languages. Each translation contains the language code and localized name/description.
Show properties
Array of ProjectPhaseTranslationDto
descriptionobject
Translated description of the project phase in this language. Provides context about when to use this phase.
languagestringrequired
ISO 639-1 language code for the translation (e.g., "en" for English, "de" for German)
nameobject
Translated name of the project phase in this language. Used for multilingual display in the user interface.
typestringrequired
Phase type enum value that determines which Kanban column the opportunity appears in. Valid values: new, inProgress, done.
Allowed:newinProgressdone
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/administration/project-settings/phases/string" \
  -H "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"
}