Get one Application

GET

api

apps

applications

{id}

Get one Application

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

import requests

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

{
  "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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the developer linked to this record.

string

Display name of the application.

boolean

Whether the application is published and available for installation.

string

Unique key identifying the application, generated by Nexudus.

string

Secret key used to authenticate API calls from the application.

string

Brief summary of the application shown in listing views.

string

Full description of the application shown on the detail page.

string

URL that Nexudus calls when a location installs this application.

integer[]

List of required roles linked to this record.

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

{
  "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
}

Get multiple ApplicationsRetrieve multiple Application records by their Ids in a single request.

Get one Application

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

import requests

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

{
  "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>"
}

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