Skip to main content
GET
/
api
/
crm
/
crmboards
/
{id}
Get one CrmBoard
curl --request GET \
  --url https://spaces.nexudus.com/api/crm/crmboards/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "Archived": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CrmBoard represents a Customer Relationship Management board used to automate processes and communication with current and potential customers. Each board represents a common sales or operational scenario (e.g. onboarding new members, offboarding cancellations, or managing a sales pipeline). Boards contain CRM stages (CrmBoardColumn entity) that define the steps opportunities move through, and each stage can trigger actions such as sending message macros or creating task lists. Nexudus provides built-in templates (e.g. sales pipeline with or without digital signature) that can be used as-is or customised by adding, removing, or editing stages. Boards can also be built from scratch.

​
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 CrmBoard-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CrmBoard record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmboards/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
Name
string
Board name identifying the CRM process (e.g. ‘Sales Pipeline’, ‘Onboarding’).
​
Archived
boolean
Whether the board is archived. Archived boards are hidden from the active board list but retain their data.
​
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
{
  "BusinessId": 0,
  "Name": "",
  "Archived": 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": "CrmBoard Example",
  "LocalizationDetails": null,
  "CustomFields": null
}