Get an opportunity

GET

/api/v1/opportunities/{id}

curl --request GET \
  --url https://digize.com/api/v1/opportunities/example \
  --header 'x-api-key: <x-api-key>'

• Digize

One opportunity with its contact, company and history.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Responses

200

Done

Media typeapplication/json

object

id

required

string

name

required

string

pipelineId

required

string

stageId

required

string

status

required

string

Allowed values: open won lost abandoned

value

required

In the workspace currency’s minor unit.

number

contact

required

Any of:

object

object

id

required

string

name

required

string

email

required

string | null

null

null

company

required

Any of:

object

object

id

required

string

name

required

string

null

null

ownerId

required

string | null

source

required

string

expectedClose

required

A day on the workspace’s calendar, such as 2026-11-14.

string | null

notes

required

string

lostReason

required

string | null

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

activity

required

Array<object>

object

id

required

string

label

required

string

detail

required

string | null

at

required

string format: date-time

Example

{
  "status": "open"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}