Skip to main content
GET
/
api
/
crm
/
crmboardcolumns
/
{id}
{
  "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>"
}

​
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

​
id
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"

​
Response

​
200

​
CrmBoardId
integer
Crm Board Id.
​
CrmBoardName
string
Crm Board Name.
​
CrmBoardBusinessId
integer
Crm Board Business Id.
​
CrmBoardBusinessName
string
Crm Board Business Name.
​
CrmBoardBusinessCurrencyId
integer
Crm Board Business Currency Id.
​
CrmBoardBusinessCurrencyCode
string
Crm Board Business Currency Code.
​
Name
string
Name.
​
Position
integer
Position.
​
TourRequests
boolean
Tour Requests.
​
ToursConfirmed
boolean
Tours Confirmed.
​
TourCompleted
boolean
Tour Completed.
​
WinOpportunity
boolean
Win Opportunity.
​
LoseOpportunity
boolean
Lose Opportunity.
​
SignUps
boolean
Sign Ups.
​
Bookings
boolean
Bookings.
​
Cancellations
boolean
Cancellations.
​
ProposalsSent
boolean
Proposals Sent.
​
ProposalsAccepted
boolean
Proposals Accepted.
​
DocumentsSigned
boolean
Documents Signed.
​
EventRegistrations
boolean
Event Registrations.
​
ContactMessages
boolean
Contact Messages.
​
CannedResponseId
integer
Canned Response Id.
​
TaskListId
integer
Task List Id.
​
UseTaskListAsResponsible
boolean
Use Task List As Responsible.
​
ActivateAccount
boolean
Activate Account.
​
DeleteAccount
boolean
Delete Account.
​
DeactivateAccount
boolean
Deactivate Account.
​
ConfirmTour
boolean
Confirm Tour.
​
ProductPurchased
boolean
Product Purchased.
​
Products
integer[]
Products.
​
ResourceBooked
boolean
Resource Booked.
​
Resources
integer[]
Resources.
​
EventCheckins
boolean
Event Checkins.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}