Search CrmBoardColumns

GET

api

crm

crmboardcolumns

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/crmboardcolumns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the CRM board that owns this stage and determines its location access..

string

Filter by display value for CrmBoard.Name..

integer

Filter by display value for CrmBoard.Business.Id..

string

Filter by display value for CrmBoard.Business.Name..

integer

Filter by display value for CrmBoard.Business.Currency.Id..

string

Filter by display value for CrmBoard.Business.Currency.Code..

string

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

integer

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

Filter by whether customers who cancel are automatically added to this stage while its board is active..

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

integer

Filter by optional ID of the message macro sent to the customer when an opportunity enters this stage..

string

Filter by display value for CannedResponse.Name..

integer

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

string

Filter by display value for TaskList.Name..

boolean

Filter by 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

Filter by 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

Filter by display value for RecordCreationWorkflowTrigger.Name..

boolean

Filter by 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

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

Range Filters

integer

Filter by display value for CrmBoard.Business.Id. greater than or equal to this value.

integer

Filter by display value for CrmBoard.Business.Id. less than or equal to this value.

integer

Filter by display value for CrmBoard.Business.Currency.Id. greater than or equal to this value.

integer

Filter by display value for CrmBoard.Business.Currency.Id. less than or equal to this value.

integer

Filter by requested relative position in the board’s stage sequence; the server normalizes saved positions to 1, 100, 200, and so on. greater than or equal to this value.

integer

Filter by requested relative position in the board’s stage sequence; the server normalizes saved positions to 1, 100, 200, and so on. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmboardcolumns?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmboardcolumns?' + new URLSearchParams({
    CrmBoardColumn_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns',
    params={
        'CrmBoardColumn_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmboardcolumns?' + new URLSearchParams({
    from_CrmBoardColumn_UpdatedOn: '2025-01-01T00:00',
    to_CrmBoardColumn_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns',
    params={
        'from_CrmBoardColumn_UpdatedOn': '2025-01-01T00:00',
        'to_CrmBoardColumn_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CrmBoardColumns

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/crmboardcolumns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200