🚧
Opportunities are only available in the pro plan and require the pipeline feature to be turned on in your workspace.

Example

{
    "id": "27eb0cd1-84b3-427c-b9c7-4b49ee441f8e",
    "name": "Acme Company AI Analysis",
    "description": "Acme Company is interested in a strategic analysis to determine the viability of several AI initiatives.",
    "nextSteps": "Have a call with the CTO.",
    "amount": 150000,
    "isActive": true,
    "probability": 1,
    "priorityId": "medium",
    "createdAt": "2024-11-07T14:07:01.686Z",
    "closeDate": "2024-11-15",
    "modifiedAt": "2025-02-03T13:44:19.455Z",
    "currency": "USD",
    "owner": {
        "id": "b6646355-8945-40aa-b798-b0d6fd89e437",
        "name": "Cameron Howe"
    },
    "opportunityType": {
        "id": "6b2b8de9-e0dd-4dad-aa8c-9130ca95c7d9",
        "name": "New Business"
    },
    "opportunityLeadSource": {
        "id": "7d33b90c-117a-4caa-9284-d4567d8e9b19",
        "name": "Partner Referral"
    },
    "tags": [
        {
            "id": "505dfa8a-3901-40c0-bce6-8b6f4887dd87",
            "name": "Subscription Services"
        },
        {
            "id": "e4aee945-fa43-451c-99d6-a05b72d0826f",
            "name": "Managed Services"
        }
    ],
    "company": {
        "id": "149929e1-c9ce-4275-8e6f-adfb01c4b4de",
        "name": "Acme Company",
        "client": {
            "id": "d5afaffe-09e5-4d73-b02c-905b40fc6c22",
            "key": "acme-company",
            "name": "Acme Company"
        }
    },
    "practice": {
        "id": "3dbcac02-2d2a-492c-9a75-ae0e01c30100",
        "name": "Artificial Intelligence"
    },
    "project": {
        "id": "76ae0ccc-65cc-446a-812d-21609c31dbef",
        "name": "Acme Company AI Analysis"
    },
    "opportunityStage": {
        "id": "0fed94b3-c5f7-40a4-9bd6-9d15c45f739d",
        "name": "Closed Won",
        "statusId": "won"
    }
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the opportunity.
`description`	`string`	A description of the opportunity.
`nextSteps`	`string`	The next steps to take for this opportunity.
`amount`	`number`	The monetary value of the opportunity.
`isActive`	`boolean`	A flag to indicate if the opportunity is currently active.
`probability`	`number`	Percentage chance of the opportunity progressing to a successful conclusion.
`priorityId`	`string`	The priority level of the opportunity. Can be `"high"`, `"medium"`, or `"low"`.
`currency`	`string`	The currency code for the opportunity.
`createdAt`	`timestamp`	The timestamp when the opportunity object was created.
`modifiedAt`	`timestamp`	The timestamp when the opportunity object was last modified.
`closeDate`	`date`	The close date of the opportunity in the format `YYYY-MM-DD`.
`owner`	`object`	The workspace member who is assigned as the owner, if defined. See attributes.
`opportunityType`	`object`	A simple object referencing the type of opportunity, if defined. See attributes.
`opportunityLeadSource`	`object`	A simple object referencing the lead source of the opportunity, if defined. See attributes.
`tags`	`array of objects`	The list of associated tags. See attributes.
`company`	`object`	A simple object referencing the associated company. See attributes.
`practice`	`object`	A simple object referencing the related practice, if defined. See attributes.
`project`	`object`	A simple object referencing the related project, if defined. See attributes.
`opportunityStage`	`object`	A simple object referencing the current stage of the opportunity, if defined. See attributes.

Member attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the member.

Opportunity type attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the opportunity type.

Lead source attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the opportunity lead source.

Tag attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the tag.

Company attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the company.
`client`	`object`	A simple object to the related client. See attributes.

Client attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`key`	`string`	A unique key representing the client.
`name`	`string`	The name of the client.

Practice attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the practice.

Project attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the project.

Opportunity stage attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the opportunity stage.
`statusId`	`string`	Unique identifier for the current state of the opportunity. Can be one of `open`, `won` or `lost`.