Get one FormPage

GET

api

content

formpages

{id}

Get one FormPage

curl --request GET \
  --url https://spaces.nexudus.com/api/content/formpages/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/formpages/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://spaces.nexudus.com/api/content/formpages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Active": true,
  "CrmBoardColumnId": 123,
  "CrmBoardColumnName": "<string>",
  "CrmBoardColumnCrmBoardId": 123,
  "CrmBoardColumnCrmBoardName": "<string>",
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A form page (FormPage) is a location-specific set of questions that administrators can send to customers or publish online for completion. Submissions can add customers to a CRM stage and create a task for a responsible user.

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 FormPage-Read role.

Path Parameters

integer

required

The Id of the FormPage record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/content/formpages/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location that owns this form page; the Admin Tool normally supplies it from the current location context.

string

Display value for Business.Name..

string

Display value for Business.WebAddress..

string

Required name used by administrators to identify this form page.

string

Required free-text description explaining the purpose of this form.

boolean

Whether this form is active and available for use.

integer

ID of the optional CRM board column that receives customers when they submit this form.

string

Display value for CrmBoardColumn.Name..

integer

Display value for CrmBoardColumn.CrmBoard.Id..

string

Display value for CrmBoardColumn.CrmBoard.Name..

integer

ID of the optional user assigned an email-notified customer task when this form is submitted.

string

Display value for Responsible.FullName..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessWebAddress": null,
  "Name": "",
  "Description": "",
  "Active": false,
  "CrmBoardColumnId": null,
  "CrmBoardColumnName": null,
  "CrmBoardColumnCrmBoardId": null,
  "CrmBoardColumnCrmBoardName": null,
  "ResponsibleId": null,
  "ResponsibleFullName": null,
  "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": "FormPage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one FormPage

curl --request GET \
  --url https://spaces.nexudus.com/api/content/formpages/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/formpages/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://spaces.nexudus.com/api/content/formpages/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Active": true,
  "CrmBoardColumnId": 123,
  "CrmBoardColumnName": "<string>",
  "CrmBoardColumnCrmBoardId": 123,
  "CrmBoardColumnCrmBoardName": "<string>",
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200