Skip to main content
GET
/
organisations
/
{orgId}
/
workspaces
/
{workspaceId}
/
opportunities
List opportunities
curl --request GET \
  --url https://api.meetsquad.ai/organisations/{orgId}/workspaces/{workspaceId}/opportunities \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "f5d8df32-60b4-417a-8b83-8d4dcb4e88e1",
      "read": false,
      "status": "New",
      "title": "Improve Customer Onboarding Experience",
      "description": "Streamline the initial user setup process to reduce drop-offs",
      "solutionsGeneratingState": "initial",
      "createdBy": "user",
      "hideContent": false,
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "hasUnseenInsights": false,
      "solutions": [],
      "insights": [],
      "outcomes": [],
      "topics": [],
      "ownerId": "d4e71c2b-a498-42af-b7f5-69de06a0d7c4"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT authentication for organization-scoped endpoints.

​
Authorization
string
header
required

API key authentication for public API endpoints. This key is scoped by workspace so a unique key is required per workspace within an organisation.

Path Parameters

​
orgId
string
required

Organization ID

​
workspaceId
string
required

Workspace ID

Query Parameters

​
relationships
string

Comma-separated list of relationships to include in the response

Response

Success

Response containing an array of opportunities

​
data
object[]
required

Array of opportunities