CrmBoardColumns
Get one CrmBoardColumn
Retrieve a single CrmBoardColumn record by its Id.
GET
Get one CrmBoardColumn
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).
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
The Id of the CrmBoardColumn record to retrieve.
Code Examples
Response
200
Crm Board Id.
Parent CRM board name.
Business ID of the parent CRM board.
Business name of the parent CRM board.
Currency ID of the parent CRM board’s business.
Currency code of the parent CRM board’s business.
Stage name (e.g. ‘Contract Signature’, ‘Keys Handout’, ‘Office Tour’).
Display order of this stage within the board (0-based).
Auto-assign: add anyone completing a tour request form to this stage.
Auto-assign: add anyone confirming a tour to this stage.
Auto-assign: add anyone completing a tour to this stage.
Auto-action: mark opportunity as won when added to this stage.
Auto-action: mark opportunity as lost when added to this stage.
Auto-assign: add anyone completing a sign-up form to this stage.
Auto-assign: add anyone placing a booking to this stage.
Auto-assign: add anyone cancelling their contract to this stage.
Auto-assign: add anyone sent a proposal to this stage.
Auto-assign: add anyone accepting a proposal to this stage.
Auto-assign: add anyone e-signing a document to this stage.
Auto-assign: add anyone registering for an event to this stage.
Auto-assign: add anyone sending a contact message to this stage.
Auto-action: message macro to send when an opportunity reaches this stage.
Auto-action: task list to create when an opportunity reaches this stage.
Assign the task list’s own responsible users instead of the opportunity owner.
Auto-action: activate the account of opportunities added to this stage.
Auto-action: permanently delete the account and all customer details of opportunities added to this stage.
Auto-action: deactivate the account of opportunities added to this stage.
Auto-action: confirm the tour of opportunities added to this stage.
Auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.
Product IDs that trigger auto-assignment when ProductPurchased is enabled.
Auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.
Resource IDs that trigger auto-assignment when ResourceBooked is enabled.
Auto-assign: add any event attendee who checks in for an event to this stage.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one CrmBoardColumn