> ## 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.

# Get one CrmBoardColumn

> Retrieve a single CrmBoardColumn record by its Id.

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-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CrmBoardColumn record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/crm/crmboardcolumns/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CrmBoardId" type="integer">
  Crm Board Id.
</ResponseField>

<ResponseField name="CrmBoardName" type="string">
  Parent CRM board name.
</ResponseField>

<ResponseField name="CrmBoardBusinessId" type="integer">
  Business ID of the parent CRM board.
</ResponseField>

<ResponseField name="CrmBoardBusinessName" type="string">
  Business name of the parent CRM board.
</ResponseField>

<ResponseField name="CrmBoardBusinessCurrencyId" type="integer">
  Currency ID of the parent CRM board's business.
</ResponseField>

<ResponseField name="CrmBoardBusinessCurrencyCode" type="string">
  Currency code of the parent CRM board's business.
</ResponseField>

<ResponseField name="Name" type="string">
  Stage name (e.g. 'Contract Signature', 'Keys Handout', 'Office Tour').
</ResponseField>

<ResponseField name="Position" type="integer">
  Display order of this stage within the board (0-based).
</ResponseField>

<ResponseField name="TourRequests" type="boolean">
  Auto-assign: add anyone completing a tour request form to this stage.
</ResponseField>

<ResponseField name="ToursConfirmed" type="boolean">
  Auto-assign: add anyone confirming a tour to this stage.
</ResponseField>

<ResponseField name="TourCompleted" type="boolean">
  Auto-assign: add anyone completing a tour to this stage.
</ResponseField>

<ResponseField name="WinOpportunity" type="boolean">
  Auto-action: mark opportunity as won when added to this stage.
</ResponseField>

<ResponseField name="LoseOpportunity" type="boolean">
  Auto-action: mark opportunity as lost when added to this stage.
</ResponseField>

<ResponseField name="SignUps" type="boolean">
  Auto-assign: add anyone completing a sign-up form to this stage.
</ResponseField>

<ResponseField name="Bookings" type="boolean">
  Auto-assign: add anyone placing a booking to this stage.
</ResponseField>

<ResponseField name="Cancellations" type="boolean">
  Auto-assign: add anyone cancelling their contract to this stage.
</ResponseField>

<ResponseField name="ProposalsSent" type="boolean">
  Auto-assign: add anyone sent a proposal to this stage.
</ResponseField>

<ResponseField name="ProposalsAccepted" type="boolean">
  Auto-assign: add anyone accepting a proposal to this stage.
</ResponseField>

<ResponseField name="DocumentsSigned" type="boolean">
  Auto-assign: add anyone e-signing a document to this stage.
</ResponseField>

<ResponseField name="EventRegistrations" type="boolean">
  Auto-assign: add anyone registering for an event to this stage.
</ResponseField>

<ResponseField name="ContactMessages" type="boolean">
  Auto-assign: add anyone sending a contact message to this stage.
</ResponseField>

<ResponseField name="CannedResponseId" type="integer">
  Auto-action: message macro to send when an opportunity reaches this stage.
</ResponseField>

<ResponseField name="TaskListId" type="integer">
  Auto-action: task list to create when an opportunity reaches this stage.
</ResponseField>

<ResponseField name="UseTaskListAsResponsible" type="boolean">
  Assign the task list's own responsible users instead of the opportunity owner.
</ResponseField>

<ResponseField name="ActivateAccount" type="boolean">
  Auto-action: activate the account of opportunities added to this stage.
</ResponseField>

<ResponseField name="DeleteAccount" type="boolean">
  Auto-action: permanently delete the account and all customer details of opportunities added to this stage.
</ResponseField>

<ResponseField name="DeactivateAccount" type="boolean">
  Auto-action: deactivate the account of opportunities added to this stage.
</ResponseField>

<ResponseField name="ConfirmTour" type="boolean">
  Auto-action: confirm the tour of opportunities added to this stage.
</ResponseField>

<ResponseField name="ProductPurchased" type="boolean">
  Auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.
</ResponseField>

<ResponseField name="Products" type="integer[]">
  Product IDs that trigger auto-assignment when ProductPurchased is enabled.
</ResponseField>

<ResponseField name="ResourceBooked" type="boolean">
  Auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.
</ResponseField>

<ResponseField name="Resources" type="integer[]">
  Resource IDs that trigger auto-assignment when ResourceBooked is enabled.
</ResponseField>

<ResponseField name="EventCheckins" type="boolean">
  Auto-assign: add any event attendee who checks in for an event to this stage.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```
