GET
/
api
/
v3
/
opportunity_workspaces
/
{id}
curl --location 'https://app.govly.com/api/v3/opportunity_workspaces/822609' \
--header 'X-API-KEY: your-api-key'
{
  "id": "822609",
  "displayName": "Govly Workspace",
  "stage": "Quoted",
  "activities": [
    {
      "createdAt": "2023-05-31T18:50:40.563512Z",
      "id": "313488",
      "message": "nick@govly.com posted a new comment"
    }
  ],
  "comments": [
    {
      "author": "nick@govly.com",
      "body": "This is a workspace comment.",
      "createdAt": "2023-05-31T18:50:40.529547Z",
      "id": "67088"
    }
  ],
  "follows": [
    {
      "follower": {
        "id": 986,
        "email": "nick@govly.com"
      },
      "state": "following"
    }
  ]
}

Get Workspace

Path Parameters

id
string
required
The ID of the workspace to retrieve. This can be found in the workspace URL. For example, given the URL https://www.govly.com/app/opportunities/8180377/workspaces/822609, the ID would be 822609.

Response

id
string
The unique identifier for the workspace
displayName
string
The display name of the workspace
stage
string
Current stage of the workspace (e.g., “Qualifying”, “Quoted”)
activities
array
Array of activity objects showing workspace history
comments
array
Array of comment objects associated with the workspace
follows
array
Array of follow objects showing who is following the workspace
opportunity
object
The full opportunity object associated with this workspace

Example Request

curl --location 'https://app.govly.com/api/v3/opportunity_workspaces/822609' \
--header 'X-API-KEY: your-api-key'
curl --location 'https://app.govly.com/api/v3/opportunity_workspaces/822609' \
--header 'X-API-KEY: your-api-key'
{
  "id": "822609",
  "displayName": "Govly Workspace",
  "stage": "Quoted",
  "activities": [
    {
      "createdAt": "2023-05-31T18:50:40.563512Z",
      "id": "313488",
      "message": "nick@govly.com posted a new comment"
    }
  ],
  "comments": [
    {
      "author": "nick@govly.com",
      "body": "This is a workspace comment.",
      "createdAt": "2023-05-31T18:50:40.529547Z",
      "id": "67088"
    }
  ],
  "follows": [
    {
      "follower": {
        "id": 986,
        "email": "nick@govly.com"
      },
      "state": "following"
    }
  ]
}