Skip to main content

Get a project

GET 
/api/projects/:id

This endpoint handles both the Project List and the Pipeline Opportunities as a single "project" resource.

Required permissions:

  • pipeline.view: allows view resources where the user is the PM or the Account.
  • pipeline.view_other: allows view resources where the user is not the PM nor the Account.

Here the dedicated support page.

Project metadata​

Project metadata appear in the response as dynamic fields named metadata_13 where 13 is the ID of the project metadata.

Only project metadata with a value will appear in the response.

You can get all the available project metadata using the related endpoint.

Request​

Path Parameters

    id integerrequired

    The ID of the project to view

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the requested project.

Schema

    id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    name stringrequired
    job_order string
    purchase_order string
    value floatrequired

    The value of the project in K

    probability integerrequired

    Possible values: <= 100

    The probability of the project

    date_start daterequired

    The first day of month where the project started

    duration integerrequired

    Possible values: >= 1

    Duration of the project in months

    is_archived booleanrequired
    archived_on date

    The date the project was archived

    due_date date

    The date the project is supposed to end

    signed_on date

    The date the project has been signed

    job_order_category_id integerrequired

    Possible values: >= 1

    ID of the job order category

    project_type_id integer

    Possible values: >= 1

    ID of the project type

    client_id integerrequired

    Possible values: >= 1

    ID of the client

    pm_id integerrequired

    Possible values: >= 1

    ID of the person who is the project manager

    account_id integer

    Possible values: >= 1

    ID of the person who is the account

    client_contact_id integer

    Possible values: >= 1

    ID of the client contact

    reason_why_id integer

    Possible values: >= 1

    ID of the reason why the project is won or lost

    business_unit_id integer

    Possible values: >= 1

    ID of the business unit

    billing_group_id integer

    Possible values: >= 1

    ID of the billing group the project is in

Loading...