List opportunities

GET

/api/v1/opportunities

const url = 'https://digize.com/api/v1/opportunities';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Every opportunity in every pipeline, each stage’s in board order, with its contact, company and history. Returns up to 1,000 rows and the total.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

rows

required

Array<object>

object

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
null

object

required

string

name

required

string

email

required

string | null

company

required

Any of:

object
null

object

required

string

name

required

string

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

required

string

label

required

string

detail

required

string | null

required

string format: date-time

total

required

number

Example

{
  "rows": [
    {
      "status": "open"
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/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.

application/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.

application/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).

application/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.

application/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"
  }
}