Search CrmOpportunities

GET

api

crm

crmopportunities

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

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 CRM opportunity (CrmOpportunity) is a potential customer deal in a location’s CRM board, assigned to one CRM stage and tracked from enquiry through an in-progress, won, or lost outcome; moving it to a stage can run that stage’s configured automation.

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 operator-facing label for this opportunity, useful when a customer has opportunities in multiple CRM boards..

integer

Filter by iD of the CRM stage that contains this opportunity and determines its location access; changing it moves the opportunity and runs that stage’s arrival actions..

string

Filter by display value for CrmBoardColumn.Name..

integer

Filter by display value for CrmBoardColumn.CrmBoard.Id..

string

Filter by display value for CrmBoardColumn.CrmBoard.Name..

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Id..

string

Filter by display value for CrmBoardColumn.CrmBoard.Business.Name..

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Currency.Id..

string

Filter by display value for CrmBoardColumn.CrmBoard.Business.Currency.Code..

integer

Filter by iD of the customer this opportunity tracks; a customer is required by backend validation even though the relationship metadata is nullable..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.Email..

integer

Filter by optional ID of the team associated with this opportunity..

string

Filter by display value for Team.Name..

string

Filter by display value for Team.Description..

string

Filter by display value for Team.ProfileWebsite..

integer

Filter by optional ID of the opportunity type used to categorize this CRM opportunity..

string

Filter by display value for OpportunityType.Name..

integer

Filter by optional ID of the staff user responsible for following up this opportunity..

string

Filter by display value for Responsible.FullName..

integer

Filter by optional ID of the customer who referred this opportunity..

integer

Filter by optional ID of the customer record representing the referring agent or broker..

string

Filter by optional internal notes about this opportunity and its follow-up..

boolean

Filter by whether this opportunity is marked complete; use Status to record whether it was won or lost..

string

Filter by optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts..

number

Filter by optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency..

boolean

Filter by whether a follow-up reminder has already been sent for this opportunity; this internal state is not exposed to Admin Tool schemas..

integer

Filter by optional acquisition source: Web, Phone, Webinar, Referral, PrintAdvert, PurchasedList, WordOfMouth, DirectEmail, EmailMarketing, Broker, PropertyAgent, Facebook, Linkedin, Instagram, Twitter, HubbleHq, LiquidSpace, GoogleSearch, SpacePool, InstantOffices, OfficeFreedom, FlexiOffices, Workthere, Kontor, Valve, OtherSocialNetwork, or Other..

integer

Filter by optional reason for a lost opportunity: Timing, Need, PoorQualification, Price, Feature, LostMomentum, Competition, ContractTerm, Duplicate, Waitlist, NotReturningCalls, LackOfFacilities, NoPetPolicy, NoRightFit, Location, Entrance, Errors, Archived, SearchOnHold, RelocationOnHold, or Other; use only when Status is Lost..

integer

Filter by lifecycle status: InProgress (1) is active, Won (2) records a successful outcome, and Lost (3) records an unsuccessful outcome; setting Won or Lost stamps the matching terminal timestamp if it is empty..

string

Filter by read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly..

string

Filter by read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly..

string

Filter by read-only UTC timestamp automatically updated after CRM changes, including a stage move..

integer

Filter by requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update..

string

Filter by optional UTM source attribution captured from the URL used to submit the originating contact or sign-up form..

string

Filter by optional UTM medium attribution captured from the URL used to submit the originating contact or sign-up form..

string

Filter by optional UTM campaign attribution captured from the URL used to submit the originating contact or sign-up form..

string

Filter by optional UTM content attribution captured from the URL used to submit the originating contact or sign-up form..

string

Filter by optional UTM search-term attribution captured from the URL used to submit the originating contact or sign-up form..

Range Filters

integer

Filter by display value for CrmBoardColumn.CrmBoard.Id. greater than or equal to this value.

integer

Filter by display value for CrmBoardColumn.CrmBoard.Id. less than or equal to this value.

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Id. greater than or equal to this value.

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Id. less than or equal to this value.

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Currency.Id. greater than or equal to this value.

integer

Filter by display value for CrmBoardColumn.CrmBoard.Business.Currency.Id. less than or equal to this value.

string

Filter by optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency. greater than or equal to this value.

number

Filter by optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency. less than or equal to this value.

string

Filter by read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp automatically updated after CRM changes, including a stage move. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp automatically updated after CRM changes, including a stage move. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update. greater than or equal to this value.

integer

Filter by requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update. 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, Reminded, LeadSource, LossReason, 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,
      "Value": null,
      "Status": 0,
      "WonOn": null,
      "LostOn": null,
      "CrmUpdatedOn": null,
      "Position": 0,
      "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
}

Search CrmOpportunities

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

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