Skip to main content
GET
/
api
/
apps
/
applications
/
{id}
{
  "DeveloperId": 123,
  "Name": "<string>",
  "Published": true,
  "ApplicationKey": "<string>",
  "SecretKey": "<string>",
  "ShortDescription": "<string>",
  "Description": "<string>",
  "InstallUrl": "<string>",
  "RequiredRoles": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
An Application represents a third-party application that can be installed as an add-on in a Nexudus account. Each application is owned by a developer and identified by a unique ApplicationKey and SecretKey pair. The InstallUrl is the endpoint Nexudus calls when a location installs the application.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
DeveloperId
integer
Developer Id.
​
Name
string
Display name of the application.
​
Published
boolean
Whether the application is published and available for installation.
​
ApplicationKey
string
Unique key identifying the application, generated by Nexudus.
​
SecretKey
string
Secret key used to authenticate API calls from the application.
​
ShortDescription
string
Brief summary of the application shown in listing views.
​
Description
string
Full description of the application shown on the detail page.
​
InstallUrl
string
URL that Nexudus calls when a location installs this application.
​
RequiredRoles
integer[]
Required Roles.
​
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
{
  "DeveloperId": 0,
  "Name": "",
  "Published": false,
  "ApplicationKey": null,
  "SecretKey": null,
  "ShortDescription": "",
  "Description": null,
  "InstallUrl": "",
  "RequiredRoles": [],
  "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": "Application Example",
  "LocalizationDetails": null,
  "CustomFields": null
}