Search CrmOpportunities

GET

api

crm

crmopportunities

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/crmopportunities \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/crmopportunities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A CrmOpportunity represents a potential or existing deal linked to a customer record that moves through stages on a CRM board. Opportunities track the lifecycle of a customer interaction — from initial enquiry or tour request through to a won or lost outcome. Each opportunity sits in a single CRM stage (CrmBoardColumn) and can be moved between stages manually or automatically via stage auto-assignment rules. Key fields:

Status — InProgress, Won, or Lost. Stages with WinOpportunity or LoseOpportunity update this automatically.
LeadSource — how the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).
LossReason — why the opportunity was lost (e.g. Price, Competition, Location). Only meaningful when Status is Lost.
Value — expected revenue if the opportunity is won.
DueDate — follow-up date for the opportunity.
UTM fields — automatically populated from the URL the opportunity used to reach the sign-up or contact form.

There is a limit of 5,000 opportunities per location.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CrmOpportunity-List role.

Enums

eCrmOpportunitySource

Value	Name
1	Web
2	Phone
4	Webinar
5	Referral
6	PrintAdvert
7	PurchasedList
8	WordOfMouth
9	DirectEmail
10	EmailMarketing
11	Broker
12	PropertyAgent
13	Facebook
14	Linkedin
15	Instagram
16	Twitter
17	HubbleHq
18	LiquidSpace
19	GoogleSearch
20	SpacePool
21	InstantOffices
22	OfficeFreedom
23	FlexiOffices
24	Workthere
25	Kontor
26	Valve
98	OtherSocialNetwork
99	Other

eCrmOpportunityLossReason

Value	Name
1	Timing
2	Need
3	PoorQualification
4	Price
5	Feature
6	LostMomentum
7	Competition
8	ContractTerm
9	Duplicate
10	Waitlist
11	NotReturningCalls
12	LackOfFacilities
13	NoPetPolicy
14	NoRightFit
15	Location
16	Entrance
17	Errors
18	Archived
19	SearchOnHold
20	RelocationOnHold
99	Other

eCrmOpportunityStatus — Status values

Value	Name
1	InProgress
2	Won
3	Lost

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

string

Filter by optional tag to identify this opportunity, useful when the same customer appears in multiple boards.

integer

Filter by iD of the crm board column linked to this record.

string

Filter by cRM stage name.

integer

Filter by cRM board ID.

string

Filter by cRM board name.

integer

Filter by business ID of the CRM board.

string

Filter by business name of the CRM board.

integer

Filter by currency ID of the CRM board’s business.

string

Filter by currency code of the CRM board’s business.

integer

Filter by iD of the coworker linked to this record.

string

Filter by customer full name.

string

Filter by customer record type.

string

Filter by customer company name.

string

Filter by customer email address.

integer

Filter by iD of the team linked to this record.

string

Filter by team name.

string

Filter by team description.

string

Filter by team profile website.

integer

Filter by opportunity type used to categorise and auto-populate general notes from a template.

string

Filter by opportunity type name.

integer

Filter by admin user responsible for managing this opportunity.

string

Filter by responsible admin full name.

integer

Filter by customer who referred this opportunity.

integer

Filter by external agent or broker who brought this opportunity.

string

Filter by general notes visible to admins when viewing the opportunity. Auto-populated from the opportunity type template if a type is assigned.

boolean

Filter by whether the opportunity has been completed (won or lost).

string

Filter by follow-up date for the opportunity.

number

Filter by expected revenue if the opportunity is won.

boolean

Filter by whether a follow-up reminder has been sent for this opportunity.

integer

Filter by how the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).

integer

Filter by why the opportunity was lost (e.g. Price, Competition, Location). Only relevant when Status is Lost.

integer

Filter by opportunity status: InProgress (still active), Won (led to a sale), or Lost (did not lead to a sale).

string

Filter by date when the opportunity was marked as won.

string

Filter by date when the opportunity was marked as lost.

string

Filter by timestamp of the last CRM-related update to this opportunity.

integer

Filter by display order of the opportunity within its current stage.

string

Filter by uTM source parameter captured from the URL the opportunity used.

string

Filter by uTM medium parameter captured from the URL the opportunity used.

string

Filter by uTM campaign parameter captured from the URL the opportunity used.

string

Filter by uTM content parameter captured from the URL the opportunity used.

string

Filter by uTM term parameter captured from the URL the opportunity used.

Range Filters

integer

Filter by cRM board ID greater than or equal to this value.

integer

Filter by cRM board ID less than or equal to this value.

integer

Filter by business ID of the CRM board greater than or equal to this value.

integer

Filter by business ID of the CRM board less than or equal to this value.

integer

Filter by currency ID of the CRM board’s business greater than or equal to this value.

integer

Filter by currency ID of the CRM board’s business less than or equal to this value.

string

Filter by follow-up date for the opportunity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by follow-up date for the opportunity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by expected revenue if the opportunity is won greater than or equal to this value.

number

Filter by expected revenue if the opportunity is won less than or equal to this value.

string

Filter by date when the opportunity was marked as won greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date when the opportunity was marked as won less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date when the opportunity was marked as lost greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date when the opportunity was marked as lost less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the last CRM-related update to this opportunity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by timestamp of the last CRM-related update to this opportunity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by display order of the opportunity within its current stage greater than or equal to this value.

integer

Filter by display order of the opportunity within its current stage less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunities?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunities?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmopportunities',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunities?CrmOpportunity_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunities?' + new URLSearchParams({
    CrmOpportunity_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmopportunities',
    params={
        'CrmOpportunity_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunities?from_CrmOpportunity_UpdatedOn=2025-01-01T00:00&to_CrmOpportunity_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunities?' + new URLSearchParams({
    from_CrmOpportunity_UpdatedOn: '2025-01-01T00:00',
    to_CrmOpportunity_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmopportunities',
    params={
        'from_CrmOpportunity_UpdatedOn': '2025-01-01T00:00',
        'to_CrmOpportunity_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CrmOpportunity[]

The list of CrmOpportunity records matching the query. See the Get one CrmOpportunity endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CrmOpportunity. The following fields are not populated in the Records[] response: TeamId, Notes, Value, Reminded, LeadSource, LossReason, Position, UtmSource, UtmMedium, UtmCampaign, UtmContent, UtmTerm.To get all fields, fetch the full record using the Get one CrmOpportunity endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "Name": null,
      "CrmBoardColumnId": 0,
      "CrmBoardColumnName": null,
      "CrmBoardColumnCrmBoardId": null,
      "CrmBoardColumnCrmBoardName": null,
      "CrmBoardColumnCrmBoardBusinessId": null,
      "CrmBoardColumnCrmBoardBusinessName": null,
      "CrmBoardColumnCrmBoardBusinessCurrencyId": null,
      "CrmBoardColumnCrmBoardBusinessCurrencyCode": null,
      "CoworkerId": null,
      "CoworkerFullName": null,
      "CoworkerCoworkerType": null,
      "CoworkerCompanyName": null,
      "CoworkerEmail": null,
      "TeamName": null,
      "TeamDescription": null,
      "TeamProfileWebsite": null,
      "OpportunityTypeId": null,
      "OpportunityTypeName": null,
      "ResponsibleId": null,
      "ResponsibleFullName": null,
      "ReferrerId": null,
      "AgentId": null,
      "Completed": false,
      "DueDate": null,
      "Status": 0,
      "WonOn": null,
      "LostOn": null,
      "CrmUpdatedOn": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CrmOpportunity Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CrmOpportunityRetrieve a single CrmOpportunity record by its Id.

Search CrmOpportunities

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/crmopportunities \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/crmopportunities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200