Skip to main content
GET
/
api
/
crm
/
crmboardcolumns
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
CrmBoardColumn_CrmBoard
integer
Filter by Crm Board Id.
​
CrmBoardColumn_CrmBoard_Name
string
Filter by Crm Board Name.
​
CrmBoardColumn_CrmBoard_Business_Id
integer
Filter by Crm Board Business Id.
​
CrmBoardColumn_CrmBoard_Business_Name
string
Filter by Crm Board Business Name.
​
CrmBoardColumn_CrmBoard_Business_Currency_Id
integer
Filter by Crm Board Business Currency Id.
​
CrmBoardColumn_CrmBoard_Business_Currency_Code
string
Filter by Crm Board Business Currency Code.
​
CrmBoardColumn_Name
string
Filter by Name.
​
CrmBoardColumn_Position
integer
Filter by Position.
​
CrmBoardColumn_TourRequests
boolean
Filter by Tour Requests.
​
CrmBoardColumn_ToursConfirmed
boolean
Filter by Tours Confirmed.
​
CrmBoardColumn_TourCompleted
boolean
Filter by Tour Completed.
​
CrmBoardColumn_WinOpportunity
boolean
Filter by Win Opportunity.
​
CrmBoardColumn_LoseOpportunity
boolean
Filter by Lose Opportunity.
​
CrmBoardColumn_SignUps
boolean
Filter by Sign Ups.
​
CrmBoardColumn_Bookings
boolean
Filter by Bookings.
​
CrmBoardColumn_Cancellations
boolean
Filter by Cancellations.
​
CrmBoardColumn_ProposalsSent
boolean
Filter by Proposals Sent.
​
CrmBoardColumn_ProposalsAccepted
boolean
Filter by Proposals Accepted.
​
CrmBoardColumn_DocumentsSigned
boolean
Filter by Documents Signed.
​
CrmBoardColumn_EventRegistrations
boolean
Filter by Event Registrations.
​
CrmBoardColumn_ContactMessages
boolean
Filter by Contact Messages.
​
CrmBoardColumn_CannedResponse
integer
Filter by Canned Response Id.
​
CrmBoardColumn_TaskList
integer
Filter by Task List Id.
​
CrmBoardColumn_UseTaskListAsResponsible
boolean
Filter by Use Task List As Responsible.
​
CrmBoardColumn_ActivateAccount
boolean
Filter by Activate Account.
​
CrmBoardColumn_DeleteAccount
boolean
Filter by Delete Account.
​
CrmBoardColumn_DeactivateAccount
boolean
Filter by Deactivate Account.
​
CrmBoardColumn_ConfirmTour
boolean
Filter by Confirm Tour.
​
CrmBoardColumn_ProductPurchased
boolean
Filter by Product Purchased.
​
CrmBoardColumn_ResourceBooked
boolean
Filter by Resource Booked.
​
CrmBoardColumn_EventCheckins
boolean
Filter by Event Checkins.

​
Range Filters

​
from_CrmBoardColumn_CrmBoardBusinessId
integer
Filter by crm board business id greater than or equal to this value.
​
to_CrmBoardColumn_CrmBoardBusinessId
integer
Filter by crm board business id less than or equal to this value.
​
from_CrmBoardColumn_CrmBoardBusinessCurrencyId
integer
Filter by crm board business currency id greater than or equal to this value.
​
to_CrmBoardColumn_CrmBoardBusinessCurrencyId
integer
Filter by crm board business currency id less than or equal to this value.
​
from_CrmBoardColumn_Position
integer
Filter by position greater than or equal to this value.
​
to_CrmBoardColumn_Position
integer
Filter by position less than or equal to this value.
​
from_CrmBoardColumn_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CrmBoardColumn_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_CrmBoardColumn_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CrmBoardColumn_UpdatedOn
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/crmboardcolumns?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmboardcolumns?CrmBoardColumn_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmboardcolumns?from_CrmBoardColumn_UpdatedOn=2025-01-01T00:00&to_CrmBoardColumn_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
CrmBoardColumn[]
The list of CrmBoardColumn records matching the query. See the Get one CrmBoardColumn endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each CrmBoardColumn. The following fields are not included in the Records[] response: TourRequests, ToursConfirmed, TourCompleted, WinOpportunity, LoseOpportunity, SignUps, Bookings, Cancellations, ProposalsSent, ProposalsAccepted, DocumentsSigned, EventRegistrations, ContactMessages, UseTaskListAsResponsible, ActivateAccount, DeleteAccount, DeactivateAccount, ConfirmTour, ProductPurchased, ResourceBooked, EventCheckins.To get all fields, fetch the full record using the Get one CrmBoardColumn 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}