// fusionrest agent · sales and service (cx)

Lightbox Documents

lightboxDocuments Based on latest (2026.09)

Create, change, delete and look up Lightbox Documents, with document download signals, document pages and document shared to user signals.

/crmRestApi/resources/11.13.18.05/lightboxDocuments
Operations
GET (list)GET (one)POST (create)PATCH (update)DELETE
Record key
LightboxDocumentId
Required on create
FileName
At a glance
38 fields4 finders10 children2 file/large text fields
I want to…List the latest 25Count recordsGet one recordCreate oneUpdate one

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Finder
Include children (expand)
Paging and options
limit
Endpoint and headers
GET /crmRestApi/resources/11.13.18.05/lightboxDocuments?fields=CreatedBy,CreationDate,CurrencyCode,CurrentRevision,DeleteFlag&limit=25&onlyData=true
Response shape (placeholders)
{
  "items": [
    {
      "CreatedBy": "<string, max 64>",
      "CreationDate": "2026-01-31T09:00:00+00:00",
      "CurrencyCode": "<string, max 15>",
      "CurrentRevision": "<string>",
      "DeleteFlag": false
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0
}

Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.

Fields 38

AttributeTypeUse
CreatedBytext · max 64Read-onlySearchable
CreationDatedate-timeRead-onlySearchable
CurrencyCodetext · max 15Optional on createUpdatableSearchable
CurrentRevisiontextRead-onlySearchable
DeleteFlagyes/noRead-only
DocumentContentstextOptional on createUpdatable
DocumentDownloadURLtextRead-onlySearchable
DocumentDownloadedCountnumberRead-onlySearchable
DocumentOwnerFlagyes/no · max 1 · default trueRead-onlySearchable
DocumentPageCountnumber · default 0Read-onlySearchable
DocumentSharedToEntityCountnumberRead-onlySearchable
DocumentSharedToUserCountnumberRead-onlySearchable
DocumentThumbnailURLtextRead-onlySearchable
DocumentTitletext · max 255Optional on createUpdatableSearchable
DocumentTypetextRead-onlySearchable
DocumentTypeCodetext · max 30Read-onlySearchable
DocumentUnsharedFromUserCountnumberRead-onlySearchable
DocumentViewedInLightboxCountnumberRead-onlySearchable
DocumentViewedOutsideLightboxCountnumberRead-onlySearchable
FileNametext · max 1000Required on createSearchable
FileSizenumber · default -1Read-onlySearchable
IsDocumentReadyFlagyes/noRead-onlySearchable
IsDocumentUploadInProgressFlagyes/no · max 1Read-onlySearchable
IsSharedWithCurrentUserFlagyes/no · max 1Read-onlySearchable
KeyPageSequenceNumbernumberOptional on createUpdatableSearchable
LastUpdateDatedate-timeRead-onlySearchable
LastUpdateLogintext · max 32Read-onlySearchable
LastUpdatedBytext · max 64Read-onlySearchable
LightboxDocumentIdtext · max 64Optional on createSearchable
OriginalOwnerEmailAddresstext · max 320Read-onlySearchable
OriginalOwnerNametext · max 450Read-onlySearchable
OriginalOwnerPartyIdnumberRead-onlySearchable
PublicDocumentDatetextRead-onlySearchable
PublicDocumentFlagyes/no · max 1 · default falseOptional on createUpdatableSearchable
SharedDatedate-timeRead-onlySearchable
ThumbnailtextRead-only
UpdateFlagyes/noRead-only
UploadDatedate-timeRead-onlySearchable

Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.

Finders 4

Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.

Check a payload

Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.

Children 10

Child resources sit under one record: /crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/<name>. Add them to a GET with expand.

Use in AI Agent Studio

More in For Builders.

Pitfalls