Get one CrmBoardColumn

GET

api

crm

crmboardcolumns

{id}

Get one CrmBoardColumn

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

import requests

url = "https://spaces.nexudus.com/api/crm/crmboardcolumns/{id}"

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/crmboardcolumns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CrmBoardId": 123,
  "CrmBoardName": "<string>",
  "CrmBoardBusinessId": 123,
  "CrmBoardBusinessName": "<string>",
  "CrmBoardBusinessCurrencyId": 123,
  "CrmBoardBusinessCurrencyCode": "<string>",
  "Name": "<string>",
  "Position": 123,
  "TourRequests": true,
  "ToursConfirmed": true,
  "TourCompleted": true,
  "WinOpportunity": true,
  "LoseOpportunity": true,
  "SignUps": true,
  "Bookings": true,
  "Cancellations": true,
  "ProposalsSent": true,
  "ProposalsAccepted": true,
  "DocumentsSigned": true,
  "EventRegistrations": true,
  "ContactMessages": true,
  "CannedResponseId": 123,
  "TaskListId": 123,
  "UseTaskListAsResponsible": true,
  "ActivateAccount": true,
  "DeleteAccount": true,
  "DeactivateAccount": true,
  "ConfirmTour": true,
  "ProductPurchased": true,
  "Products": [
    123
  ],
  "ResourceBooked": true,
  "Resources": [
    123
  ],
  "EventCheckins": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CrmBoardColumn represents a stage (step) within a CRM board. In the Nexudus UI these are called CRM Stages. Each stage has two main components:

Auto assignment — controls which opportunities are automatically added to this stage. Enable one of the boolean triggers (e.g. TourRequests, SignUps, Cancellations, ProductPurchased) to auto-populate the stage when the corresponding event occurs.
Auto actions — controls what happens when an opportunity reaches this stage. Assign a message macro (CannedResponseId), a task list (TaskListId), and/or an account action (ActivateAccount, DeactivateAccount, DeleteAccount, ConfirmTour, WinOpportunity, LoseOpportunity).

Stages are ordered by Position within their parent board. Opportunities move through stages either automatically (when conditions are met) or manually.

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 CrmBoardColumn-Read role.

Path Parameters

integer

required

The Id of the CrmBoardColumn record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the crm board linked to this record.

string

Parent CRM board name.

integer

Business ID of the parent CRM board.

string

Business name of the parent CRM board.

integer

Currency ID of the parent CRM board’s business.

string

Currency code of the parent CRM board’s business.

string

Stage name (e.g. ‘Contract Signature’, ‘Keys Handout’, ‘Office Tour’).

integer

Display order of this stage within the board (0-based).

boolean

Auto-assign: add anyone completing a tour request form to this stage.

boolean

Auto-assign: add anyone confirming a tour to this stage.

boolean

Auto-assign: add anyone completing a tour to this stage.

boolean

Auto-action: mark opportunity as won when added to this stage.

boolean

Auto-action: mark opportunity as lost when added to this stage.

boolean

Auto-assign: add anyone completing a sign-up form to this stage.

boolean

Auto-assign: add anyone placing a booking to this stage.

boolean

Auto-assign: add anyone cancelling their contract to this stage.

boolean

Auto-assign: add anyone sent a proposal to this stage.

boolean

Auto-assign: add anyone accepting a proposal to this stage.

boolean

Auto-assign: add anyone e-signing a document to this stage.

boolean

Auto-assign: add anyone registering for an event to this stage.

boolean

Auto-assign: add anyone sending a contact message to this stage.

integer

Auto-action: message macro to send when an opportunity reaches this stage.

integer

Auto-action: task list to create when an opportunity reaches this stage.

boolean

Assign the task list’s own responsible users instead of the opportunity owner.

boolean

Auto-action: activate the account of opportunities added to this stage.

boolean

Auto-action: permanently delete the account and all customer details of opportunities added to this stage.

boolean

Auto-action: deactivate the account of opportunities added to this stage.

boolean

Auto-action: confirm the tour of opportunities added to this stage.

boolean

Auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.

integer[]

Product IDs that trigger auto-assignment when ProductPurchased is enabled.

boolean

Auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.

integer[]

Resource IDs that trigger auto-assignment when ResourceBooked is enabled.

boolean

Auto-assign: add any event attendee who checks in for an event to this stage.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "CrmBoardId": 0,
  "CrmBoardName": null,
  "CrmBoardBusinessId": null,
  "CrmBoardBusinessName": null,
  "CrmBoardBusinessCurrencyId": null,
  "CrmBoardBusinessCurrencyCode": null,
  "Name": "",
  "Position": 0,
  "TourRequests": false,
  "ToursConfirmed": false,
  "TourCompleted": false,
  "WinOpportunity": false,
  "LoseOpportunity": false,
  "SignUps": false,
  "Bookings": false,
  "Cancellations": false,
  "ProposalsSent": false,
  "ProposalsAccepted": false,
  "DocumentsSigned": false,
  "EventRegistrations": false,
  "ContactMessages": false,
  "CannedResponseId": null,
  "TaskListId": null,
  "UseTaskListAsResponsible": false,
  "ActivateAccount": false,
  "DeleteAccount": false,
  "DeactivateAccount": false,
  "ConfirmTour": false,
  "ProductPurchased": false,
  "Products": [],
  "ResourceBooked": false,
  "Resources": [],
  "EventCheckins": false,
  "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": "CrmBoardColumn Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CrmBoardColumnsRetrieve multiple CrmBoardColumn records by their Ids in a single request.

Get one CrmBoardColumn

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

import requests

url = "https://spaces.nexudus.com/api/crm/crmboardcolumns/{id}"

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/crmboardcolumns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CrmBoardId": 123,
  "CrmBoardName": "<string>",
  "CrmBoardBusinessId": 123,
  "CrmBoardBusinessName": "<string>",
  "CrmBoardBusinessCurrencyId": 123,
  "CrmBoardBusinessCurrencyCode": "<string>",
  "Name": "<string>",
  "Position": 123,
  "TourRequests": true,
  "ToursConfirmed": true,
  "TourCompleted": true,
  "WinOpportunity": true,
  "LoseOpportunity": true,
  "SignUps": true,
  "Bookings": true,
  "Cancellations": true,
  "ProposalsSent": true,
  "ProposalsAccepted": true,
  "DocumentsSigned": true,
  "EventRegistrations": true,
  "ContactMessages": true,
  "CannedResponseId": 123,
  "TaskListId": 123,
  "UseTaskListAsResponsible": true,
  "ActivateAccount": true,
  "DeleteAccount": true,
  "DeactivateAccount": true,
  "ConfirmTour": true,
  "ProductPurchased": true,
  "Products": [
    123
  ],
  "ResourceBooked": true,
  "Resources": [
    123
  ],
  "EventCheckins": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200