Get one FormPageRequest

GET

api

content

formpagerequests

{id}

Get one FormPageRequest

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

import requests

url = "https://spaces.nexudus.com/api/content/formpagerequests/{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/formpagerequests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "FormPageId": 123,
  "FormPageName": "<string>",
  "FormPageBusinessName": "<string>",
  "SentOn": "<string>",
  "Submitted": true,
  "EventAttendeeUniqueId": "<string>",
  "CalendarEventUniqueId": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A form request (FormPageRequest) sends a location’s form to a customer and tracks its submission. Creating a request sends an invitation unless it is already submitted; submitted answers are stored as separate records.

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

Path Parameters

integer

required

The Id of the FormPageRequest record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer invited to complete this form; cannot be changed after the request is created.

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.Email..

integer

ID of the form sent to the customer; the form’s location owns this request.

string

Display value for FormPage.Name..

string

Display value for FormPage.Business.Name..

string

UTC timestamp set automatically when the request is created and the invitation is sent.

boolean

Whether the customer has submitted the form; set automatically by the public submission workflow.

string

System-managed unique ID linking this request to an event attendee; set by the event workflow and never supplied by an agent.

string

System-managed unique ID linking this request to an event; set by the event workflow and never supplied by an agent.

string

System-managed unique ID linking this request to a customer contract; set by the contract workflow and never supplied by an agent.

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

{
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "CoworkerEmail": null,
  "FormPageId": 0,
  "FormPageName": null,
  "FormPageBusinessName": null,
  "SentOn": null,
  "Submitted": false,
  "EventAttendeeUniqueId": null,
  "CalendarEventUniqueId": null,
  "CoworkerContractUniqueId": 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": "FormPageRequest Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one FormPageRequest

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

import requests

url = "https://spaces.nexudus.com/api/content/formpagerequests/{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/formpagerequests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerEmail": "<string>",
  "FormPageId": 123,
  "FormPageName": "<string>",
  "FormPageBusinessName": "<string>",
  "SentOn": "<string>",
  "Submitted": true,
  "EventAttendeeUniqueId": "<string>",
  "CalendarEventUniqueId": "<string>",
  "CoworkerContractUniqueId": "<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