Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Portfolio

6 endpoints6 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/portfolioCompany portfolio roll-up
  2. GET /rest/v1.0/companies/{company_id}/programsList programs
  3. POST /rest/v1.0/companies/{company_id}/programsCreate a program
  4. GET /rest/v1.0/companies/{company_id}/programs/{id}Show a program
  5. PATCH /rest/v1.0/companies/{company_id}/programs/{id}Update a program
  6. DELETE /rest/v1.0/companies/{company_id}/programs/{id}Delete a program
GET /rest/v1.0/companies/{company_id}/portfolio

Company portfolio roll-up

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · object

  • projects
    object[]required
  • totals
    objectrequired
GET /rest/v1.0/companies/{company_id}/programs

List programs

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • address_freeform
    string | null
  • website
    string | null
  • zip
    string | null
  • latitude
    string | null
  • longitude
    string | null
  • project_ids
    integer[]required
  • project_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
POST /rest/v1.0/companies/{company_id}/programs

Create a program

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • address_freeform
    string | null
  • website
    string | null
  • zip
    string | null
  • latitude
    string | null
  • longitude
    string | null
  • project_ids
    integer[]required
  • project_count
    integerrequired
  • projects
    object[]required
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/companies/{company_id}/programs/{id}

Show a program

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • address_freeform
    string | null
  • website
    string | null
  • zip
    string | null
  • latitude
    string | null
  • longitude
    string | null
  • project_ids
    integer[]required
  • project_count
    integerrequired
  • projects
    object[]required
  • created_at
    stringrequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/companies/{company_id}/programs/{id}

Update a program

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • address_freeform
    string | null
  • website
    string | null
  • zip
    string | null
  • latitude
    string | null
  • longitude
    string | null
  • project_ids
    integer[]required
  • project_count
    integerrequired
  • projects
    object[]required
  • created_at
    stringrequired
  • updated_at
    stringrequired
DELETE /rest/v1.0/companies/{company_id}/programs/{id}

Delete a program

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 204

No response body.

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file