/opportunities

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
const pageableResponse = await client.crm.opportunities.list({
    accountId: "account_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    ownerId: "owner_id",
    pageSize: 1,
    remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
    remoteFields: "status",
    remoteId: "remote_id",
    showEnumOrigins: "status",
    stageId: "stage_id",
    status: "LOST"
});
for await (const item of pageableResponse) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.crm.opportunities.list({
    accountId: "account_id",
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    includeDeletedData: true,
    includeRemoteData: true,
    includeRemoteFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    ownerId: "owner_id",
    pageSize: 1,
    remoteCreatedAfter: new Date("2024-01-15T09:30:00.000Z"),
    remoteFields: "status",
    remoteId: "remote_id",
    showEnumOrigins: "status",
    stageId: "stage_id",
    status: "LOST"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "remote_id": "19202938",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "name": "Needs Integrations",
      "description": "Needs a Unified API for Integrations!",
      "amount": 100000,
      "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
      "stage": "1968cbc6-6040-430a-848e-aafacbadf4ad",
      "status": "WON",
      "last_activity_at": "2022-02-10T00:00:00Z",
      "close_date": "2022-02-10T00:00:00Z",
      "remote_created_at": "2021-11-10T00:00:00Z",
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      },
      "remote_data": [
        {
          "path": "/opportunities"
        }
      ],
      "remote_fields": [
        {
          "remote_field_class": {
            "id": "string",
            "display_name": "string",
            "remote_key_name": "string",
            "description": "string",
            "is_custom": true,
            "is_common_model_field": true,
            "is_required": true,
            "field_type": "string",
            "field_format": "string",
            "field_choices": [
              "string"
            ],
            "item_schema": {
              "item_type": "string",
              "item_format": "string",
              "item_choices": [
                "string"
              ]
            }
          },
          "value": "string"
        }
      ]
    }
  ]
}

Returns a list of Opportunity objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

account_idstringOptional

If provided, will only return opportunities with this account.

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_databooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

owner_idstringOptional

If provided, will only return opportunities with this owner.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_created_afterdatetimeOptional

If provided, will only return opportunities created in the third party platform after this datetime.

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

remote_idstringOptional

The API provider's ID for the given object.

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

stage_idstringOptional

If provided, will only return opportunities with this stage.

statusenumOptional

If provided, will only return opportunities with this status. Options: (‘OPEN’, ‘WON’, ‘LOST’)

OPEN - OPEN
WON - WON
LOST - LOST

If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') * `OPEN` - OPEN * `WON` - WON * `LOST` - LOST

Allowed values:

Response

nextstring or null

previousstring or null

resultslist of objects

/opportunities

Authentication

Headers

Query parameters

Response

Field support by integration