Skip to main content

Get Project details

GET 
/api/v1/project/:projectIdentifier

Get Project details

Request​

Path Parameters

    projectIdentifier stringrequired

    Project identifier (ID or name)

Responses​

Schema

    id numberrequired

    Unique identifier of the project

    name stringrequired

    Unique slug name of the project

    projectName string

    Human-friendly name of the project (not unique)

    description string
    projectType stringrequired

    Possible values: [product, application, lib, bundle, infra]

    status string

    Status of the project (active, completed, on-hold)

    label string

    Label name assigned to the project

    owner stringrequired

    Owner of the project

    platforms string[]

    Platforms supported by the project

    numMembers number

    Number of members in the project

    versions numberrequired

    Number of versions available for the project

    memberContext

    object

    role stringrequired

    Possible values: [project-owner, project-admin, project-member]

    preferences

    object

    required

    pinned boolean

    summary

    object

    latestRelease

    object

    Latest release of the project

    id stringrequired
    version stringrequired
    name string
    requiredRegulationsCount numberrequired
    compliantRegulationsCount numberrequired

    upcomingRelease

    object

    Upcoming release of the project

    id stringrequired
    version stringrequired
    name string
    requiredRegulationsCount numberrequired
    compliantRegulationsCount numberrequired
    createdAt date-timerequired

    members

    object[]

  • Array [

    • id numberrequired
    firstName string
    lastName string
    email stringrequired
    role stringrequired

    Possible values: [project-owner, project-admin, project-member]

    status stringrequired

    Possible values: [invited, active, inactive]

    defaultProject number

    Default value: -1

  • ]

    • tokens

    object[]

  • Array [

    • id numberrequired
    name stringrequired
    token stringrequired
    expirationDate date-time
    neverExpires booleanrequired

    Default value: false

    isActive booleanrequired

    Default value: true

    createdAt date-timerequired

  • ]

    • gitWebhookUrl string

    Generated webhook URL for git integration

    gitCloneUrl string

    Git repository clone URL (HTTPS or SSH)

    gitSshKeyConfigured boolean

    Whether an SSH private key is configured for git authentication

    gitCloneInterval number

    Interval in minutes for periodic git clone

    gitBranch string

    Branch to clone (defaults to repository default branch)

    gitHttpsCredentialsConfigured boolean

    Whether HTTPS username/password credentials are configured

    gitAuthMethod string

    Possible values: [ssh_key, https_credentials, none]

    Git authentication method in use

    gitGetappFilePath string

    Path to the .getapp file within the repository (defaults to repo root)

Loading...