> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CrmBoardColumns

> Search and list CrmBoardColumn records with filtering, sorting, and pagination.

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`).

Stages are ordered by `Position` within their parent board. Opportunities move through stages either automatically (when conditions are met) or manually.

## Authentication

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CrmBoardColumn_CrmBoard" type="integer">
  Filter by Crm Board Id.
</ParamField>

<ParamField query="CrmBoardColumn_CrmBoard_Name" type="string">
  Filter by parent CRM board name.
</ParamField>

<ParamField query="CrmBoardColumn_CrmBoard_Business_Id" type="integer">
  Filter by business ID of the parent CRM board.
</ParamField>

<ParamField query="CrmBoardColumn_CrmBoard_Business_Name" type="string">
  Filter by business name of the parent CRM board.
</ParamField>

<ParamField query="CrmBoardColumn_CrmBoard_Business_Currency_Id" type="integer">
  Filter by currency ID of the parent CRM board's business.
</ParamField>

<ParamField query="CrmBoardColumn_CrmBoard_Business_Currency_Code" type="string">
  Filter by currency code of the parent CRM board's business.
</ParamField>

<ParamField query="CrmBoardColumn_Name" type="string">
  Filter by stage name (e.g. 'Contract Signature', 'Keys Handout', 'Office Tour').
</ParamField>

<ParamField query="CrmBoardColumn_Position" type="integer">
  Filter by display order of this stage within the board (0-based).
</ParamField>

<ParamField query="CrmBoardColumn_TourRequests" type="boolean">
  Filter by auto-assign: add anyone completing a tour request form to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ToursConfirmed" type="boolean">
  Filter by auto-assign: add anyone confirming a tour to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_TourCompleted" type="boolean">
  Filter by auto-assign: add anyone completing a tour to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_WinOpportunity" type="boolean">
  Filter by auto-action: mark opportunity as won when added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_LoseOpportunity" type="boolean">
  Filter by auto-action: mark opportunity as lost when added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_SignUps" type="boolean">
  Filter by auto-assign: add anyone completing a sign-up form to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_Bookings" type="boolean">
  Filter by auto-assign: add anyone placing a booking to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_Cancellations" type="boolean">
  Filter by auto-assign: add anyone cancelling their contract to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ProposalsSent" type="boolean">
  Filter by auto-assign: add anyone sent a proposal to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ProposalsAccepted" type="boolean">
  Filter by auto-assign: add anyone accepting a proposal to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_DocumentsSigned" type="boolean">
  Filter by auto-assign: add anyone e-signing a document to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_EventRegistrations" type="boolean">
  Filter by auto-assign: add anyone registering for an event to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ContactMessages" type="boolean">
  Filter by auto-assign: add anyone sending a contact message to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_CannedResponse" type="integer">
  Filter by auto-action: message macro to send when an opportunity reaches this stage.
</ParamField>

<ParamField query="CrmBoardColumn_TaskList" type="integer">
  Filter by auto-action: task list to create when an opportunity reaches this stage.
</ParamField>

<ParamField query="CrmBoardColumn_UseTaskListAsResponsible" type="boolean">
  Filter by assign the task list's own responsible users instead of the opportunity owner.
</ParamField>

<ParamField query="CrmBoardColumn_ActivateAccount" type="boolean">
  Filter by auto-action: activate the account of opportunities added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_DeleteAccount" type="boolean">
  Filter by auto-action: permanently delete the account and all customer details of opportunities added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_DeactivateAccount" type="boolean">
  Filter by auto-action: deactivate the account of opportunities added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ConfirmTour" type="boolean">
  Filter by auto-action: confirm the tour of opportunities added to this stage.
</ParamField>

<ParamField query="CrmBoardColumn_ProductPurchased" type="boolean">
  Filter by auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.
</ParamField>

<ParamField query="CrmBoardColumn_ResourceBooked" type="boolean">
  Filter by auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.
</ParamField>

<ParamField query="CrmBoardColumn_EventCheckins" type="boolean">
  Filter by auto-assign: add any event attendee who checks in for an event to this stage.
</ParamField>

### Range Filters

<ParamField query="from_CrmBoardColumn_CrmBoardBusinessId" type="integer">
  Filter by business ID of the parent CRM board greater than or equal to this value.
</ParamField>

<ParamField query="to_CrmBoardColumn_CrmBoardBusinessId" type="integer">
  Filter by business ID of the parent CRM board less than or equal to this value.
</ParamField>

<ParamField query="from_CrmBoardColumn_CrmBoardBusinessCurrencyId" type="integer">
  Filter by currency ID of the parent CRM board's business greater than or equal to this value.
</ParamField>

<ParamField query="to_CrmBoardColumn_CrmBoardBusinessCurrencyId" type="integer">
  Filter by currency ID of the parent CRM board's business less than or equal to this value.
</ParamField>

<ParamField query="from_CrmBoardColumn_Position" type="integer">
  Filter by display order of this stage within the board (0-based) greater than or equal to this value.
</ParamField>

<ParamField query="to_CrmBoardColumn_Position" type="integer">
  Filter by display order of this stage within the board (0-based) less than or equal to this value.
</ParamField>

<ParamField query="from_CrmBoardColumn_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CrmBoardColumn_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CrmBoardColumn_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CrmBoardColumn_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/crmboardcolumns?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/crmboardcolumns?CrmBoardColumn_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CrmBoardColumn[]">
  The list of CrmBoardColumn records matching the query. See the [Get one CrmBoardColumn](/rest-api/crm/get-crmboardcolumns-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CrmBoardColumn. The following fields are **not populated** 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](/rest-api/crm/get-crmboardcolumns-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "CrmBoardId": 0,
      "CrmBoardName": null,
      "CrmBoardBusinessId": null,
      "CrmBoardBusinessName": null,
      "CrmBoardBusinessCurrencyId": null,
      "CrmBoardBusinessCurrencyCode": null,
      "Name": "",
      "Position": 0,
      "CannedResponseId": null,
      "TaskListId": null,
      "Products": [],
      "Resources": [],
      "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
}
```