Get one BusinessBackgroundJob

GET

api

sys

businessbackgroundjobs

{id}

Get one BusinessBackgroundJob

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

import requests

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "JobId": "<string>",
  "Description": "<string>",
  "Files": "<string>",
  "Status": "<string>",
  "ResultData": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A BusinessBackgroundJob is an internal, read-only entity representing background jobs used for bulk edits or imports. It is not intended for direct use by end users. Each record tracks a single asynchronous job: who triggered it, its current status, a human-readable description, and any result data produced when the job completes.

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

Path Parameters

integer

required

The Id of the BusinessBackgroundJob record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Location name.

integer

ID of the user linked to this record.

string

Full name of the user who triggered the job.

string

Email of the user who triggered the job.

string

Unique identifier (GUID) of the background job.

string

Human-readable description of what the job does.

string

Files associated with the job (e.g. import files).

string

Current status of the background job.

string

Result data produced when the job completes.

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,
  "UserId": null,
  "UserFullName": null,
  "UserEmail": null,
  "JobId": null,
  "Description": null,
  "Files": null,
  "Status": null,
  "ResultData": 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": "BusinessBackgroundJob Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple BusinessBackgroundJobsRetrieve multiple BusinessBackgroundJob records by their Ids in a single request.

Get one BusinessBackgroundJob

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

import requests

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "JobId": "<string>",
  "Description": "<string>",
  "Files": "<string>",
  "Status": "<string>",
  "ResultData": "<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

Get one BusinessBackgroundJob

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200