---
title: "List opportunities"
method: GET
path: "/opportunities"
tags: ["Opportunities"]
---

# List opportunities

`GET /opportunities`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/opportunities`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `name` string

## Response `200`

200

- object
  - `results` Opportunity[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `name` string: The name of the opportunity.
    - `description` string, nullable: A description of the opportunity.
    - `nextSteps` string, nullable: The next steps for the opportunity.
    - `amount` number, nullable: The monetary amount of the opportunity.
    - `probability` number: The probability of the opportunity closing successfully, expressed as a decimal between 0 and 1.
    - `priorityId` 'high' | 'medium' | 'low', nullable: The priority level of the opportunity.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `openDate` string, date: The date the opportunity was opened. Will be in the form YYYY-MM-DD.
    - `closeDate` string, date, nullable: The expected close date for the opportunity. Will be in the form YYYY-MM-DD.
    - `modifiedAt` string, date-time: The timestamp when the object was last modified.
    - `currency` string: The 3-letter currency code for the opportunity.
    - `cloudFolderUrl` string, nullable: A URL to a cloud folder associated with the opportunity.
    - `weightedAmount` number, nullable: The probability-weighted amount, calculated as `amount` multiplied by `probability`.
    - `owner` object, nullable: The owner of the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the member.
    - `opportunityLeadSource` object, nullable: The lead source for the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the lead source.
    - `opportunityType` object, nullable: The type of the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the opportunity type.
    - `tags` object[]: The tags associated with the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the tag.
    - `practice` object, nullable: The practice associated with the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the practice.
    - `businessUnit` object, nullable: The business unit associated with the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the business unit.
    - `company` object: The company associated with the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the company.
      - `client` object, nullable: The client associated with the company.
        - `id` string: The unique identifier for the object.
        - `key` string: The client key.
        - `name` string: The name of the client.
    - `projects` object[]: The projects associated with the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the project.
      - `amount` number, nullable: The amount allocated to this project from the opportunity.
    - `opportunityStage` object: The current stage of the opportunity.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the opportunity stage.
      - `statusId` 'open' | 'won' | 'lost': The status of the opportunity stage.
    - `opportunityPipeline` object: The pipeline the opportunity belongs to.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the pipeline.
    - `timeSpent` integer: Total time spent in minutes across all pipeline activities.
    - `salesforceId` string, nullable: The Salesforce opportunity ID. Will be `null` unless synced via the Salesforce integration.
    - `hubspotId` string, nullable: The HubSpot deal ID. Will be `null` unless synced via the HubSpot integration.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400
- `403`: 403

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)