Get one CrmOpportunityImportFile

GET

api

crm

crmopportunityimportfiles

{id}

Get one CrmOpportunityImportFile

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

import requests

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

{
  "BusinessId": 123,
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "Name": "<string>",
  "Imported": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CrmOpportunityImportFile represents a file uploaded to bulk-import CRM opportunities into the system. Each record tracks the import file metadata and processing status.

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

Path Parameters

integer

required

The Id of the CrmOpportunityImportFile record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Current file name of the file data (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the file data.

boolean

Set to true to remove the current file data file.

string

The name value for this crm opportunity import file.

boolean

Whether imported is enabled.

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,
  "FileDataFileName": null,
  "NewFileDataUrl": null,
  "ClearFileDataFile": null,
  "Name": "",
  "Imported": false,
  "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": "CrmOpportunityImportFile Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CrmOpportunityImportFilesRetrieve multiple CrmOpportunityImportFile records by their Ids in a single request.

Get one CrmOpportunityImportFile

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

import requests

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

{
  "BusinessId": 123,
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "Name": "<string>",
  "Imported": true,
  "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 CrmOpportunityImportFile

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200