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,
  "CannedResponseName": "<string>",
  "TaskListId": 123,
  "TaskListName": "<string>",
  "UseTaskListAsResponsible": true,
  "RecordCreationWorkflowTriggerId": 123,
  "RecordCreationWorkflowTriggerName": "<string>",
  "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 CRM stage (CrmBoardColumn) is an ordered step in a location’s CRM board that can automatically add customers after selected events and run message, task, account, tour, opportunity-status, or record-creation-workflow actions when an opportunity enters it.

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 that owns this stage and determines its location access..

string

Display value for CrmBoard.Name..

integer

Display value for CrmBoard.Business.Id..

string

Display value for CrmBoard.Business.Name..

integer

Display value for CrmBoard.Business.Currency.Id..

string

Display value for CrmBoard.Business.Currency.Code..

string

Required unique name for this CRM stage within its workflow, such as Contract Signature or Office Tour..

integer

Requested relative position in the board’s stage sequence; the server normalizes saved positions to 1, 100, 200, and so on..

boolean

Whether customers who submit a tour request are automatically added to this stage while its board is active..

boolean

Whether customers who confirm a tour are automatically added to this stage while its board is active..

boolean

Whether customers who complete a tour are automatically added to this stage while its board is active..

boolean

Whether moving an existing opportunity to this stage marks it won; when both WinOpportunity and LoseOpportunity are true, winning is applied last..

boolean

Whether moving an existing opportunity to this stage marks it lost; WinOpportunity overrides this final status when both are true..

boolean

Whether customers who complete sign-up are automatically added to this stage while its board is active..

boolean

Whether customers who make a booking are automatically added to this stage while its board is active..

boolean

Whether customers who cancel are automatically added to this stage while its board is active..

boolean

Whether customers who are sent a proposal are automatically added to this stage while its board is active..

boolean

Whether customers who accept a proposal are automatically added to this stage while its board is active..

boolean

Whether customers who electronically sign a document are automatically added to this stage while its board is active..

boolean

Whether customers who register for an event are automatically added to this stage while its board is active..

boolean

Whether customers who send a contact message are automatically added to this stage while its board is active..

integer

Optional ID of the message macro sent to the customer when an opportunity enters this stage..

string

Display value for CannedResponse.Name..

integer

Optional ID of the task list whose tasks are created for the customer when an opportunity enters this stage..

string

Display value for TaskList.Name..

boolean

Whether task-list tasks use the task list’s configured assignees instead of the opportunity’s responsible user; applies only when TaskList is set..

integer

Read-only mirror of the enabled CRM stage workflow trigger that runs when an opportunity enters this stage. Set it by choosing this board and stage on the workflow trigger and enabling it, not by writing this field; disabling or repointing that trigger clears it..

string

Display value for RecordCreationWorkflowTrigger.Name..

boolean

Whether arrival at this stage activates the customer’s account and creates a user account when one is missing; DeactivateAccount runs afterward when also enabled..

boolean

Whether arrival at this stage schedules permanent deletion of the customer’s account and details shortly after the opportunity is moved..

boolean

Whether arrival at this stage deactivates the customer’s account; it runs after ActivateAccount when both are enabled..

boolean

Whether arrival at this stage confirms every unconfirmed tour at this location matching the customer’s email address..

boolean

Whether customers who purchase a selected product are automatically added to this stage; it is cleared when Products is empty or disabled..

integer[]

List of product IDs that trigger auto-assignment when ProductPurchased is enabled; the list must be non-empty and no product can trigger another stage in the same board..

boolean

Whether customers who book a selected resource are automatically added to this stage; it is cleared when Resources is empty or disabled..

integer[]

List of resource IDs that trigger auto-assignment when ResourceBooked is enabled; the list must be non-empty and no resource can trigger another stage in the same board..

boolean

Whether customers who check in to an event are automatically added to this stage while its board is active..

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,
  "CannedResponseName": null,
  "TaskListId": null,
  "TaskListName": null,
  "UseTaskListAsResponsible": false,
  "RecordCreationWorkflowTriggerId": null,
  "RecordCreationWorkflowTriggerName": null,
  "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 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,
  "CannedResponseName": "<string>",
  "TaskListId": 123,
  "TaskListName": "<string>",
  "UseTaskListAsResponsible": true,
  "RecordCreationWorkflowTriggerId": 123,
  "RecordCreationWorkflowTriggerName": "<string>",
  "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