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.
- 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
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/lightboxDocuments?fields=CreatedBy,CreationDate,CurrencyCode,CurrentRevision,DeleteFlag&limit=25&onlyData=true
{
"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
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
CurrentRevision | text | Read-onlySearchable |
DeleteFlag | yes/no | Read-only |
DocumentContents | text | Optional on createUpdatable |
DocumentDownloadURL | text | Read-onlySearchable |
DocumentDownloadedCount | number | Read-onlySearchable |
DocumentOwnerFlag | yes/no · max 1 · default true | Read-onlySearchable |
DocumentPageCount | number · default 0 | Read-onlySearchable |
DocumentSharedToEntityCount | number | Read-onlySearchable |
DocumentSharedToUserCount | number | Read-onlySearchable |
DocumentThumbnailURL | text | Read-onlySearchable |
DocumentTitle | text · max 255 | Optional on createUpdatableSearchable |
DocumentType | text | Read-onlySearchable |
DocumentTypeCode | text · max 30 | Read-onlySearchable |
DocumentUnsharedFromUserCount | number | Read-onlySearchable |
DocumentViewedInLightboxCount | number | Read-onlySearchable |
DocumentViewedOutsideLightboxCount | number | Read-onlySearchable |
FileName | text · max 1000 | Required on createSearchable |
FileSize | number · default -1 | Read-onlySearchable |
IsDocumentReadyFlag | yes/no | Read-onlySearchable |
IsDocumentUploadInProgressFlag | yes/no · max 1 | Read-onlySearchable |
IsSharedWithCurrentUserFlag | yes/no · max 1 | Read-onlySearchable |
KeyPageSequenceNumber | number | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
LightboxDocumentId | text · max 64 | Optional on createSearchable |
OriginalOwnerEmailAddress | text · max 320 | Read-onlySearchable |
OriginalOwnerName | text · max 450 | Read-onlySearchable |
OriginalOwnerPartyId | number | Read-onlySearchable |
PublicDocumentDate | text | Read-onlySearchable |
PublicDocumentFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
SharedDate | date-time | Read-onlySearchable |
Thumbnail | text | Read-only |
UpdateFlag | yes/no | Read-only |
UploadDate | date-time | Read-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.
LightboxDocumentById·LightboxDocumentIdMyLightboxDocumentsRFSharedLightboxDocumentsRFSubordinatesLightboxDocumentsRF
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.
documentDownloadSignalsGET Lightbox Scoring Signals · 9 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdSignalDatedocumentPagesGET · PATCH Lightbox Document Pages · 22 fields · 1 findersCreatedByCreationDateCurrencyCodeDocumentCurrentVersionDocumentPageCountDocumentPageImageURLDocumentPageThumbnailURLLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentPageIdLightboxDocumentRevisionPageAddedToCartCountPageDisplayTitlePageDownloadedInCartCountPageSequenceNumberPageThumbnailPageTitlePageViewedOutsideLightboxCountSharedDateSimplePageDisplayTitleUpdateFlagpageAddedToCartSignalsGET Page-added-to-cart Signals · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdPageSequenceNumberSignalDatepageDownloadedInCartSignalsGET Downloaded-from-cart Signals · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdPageSequenceNumberSignalDatepageViewedOutsideLightboxSignalsGET · POST Page-viewed-outside-Lightbox Signals · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdPageSequenceNumberSignalDatedocumentSharedToUserSignalsGET Document-shared-with-user Signals · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdSignalDateSignalSubjectIdentifierdocumentUnsharedFromUserSignalsGET Document-unshared-with-user Signals · 10 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdSignalDateSignalSubjectIdentifierdocumentViewedInLightboxSignalsGET Document-Viewed-Within-Lightbox Signals · 9 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdSignalDatedocumentViewedOutsideLightboxSignalsGET · POST Document-viewed-outside-Lightbox Signals · 9 fieldsCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdLightboxDocumentRevisionLightboxSignalIdSignalDatesharedPersonsGET · POST · DELETE Shared-person Instances · 17 fieldsCreatedByCreationDateDeleteFlagEmailAddressIsJointOwnerFlagLastUpdateDateLastUpdateLoginLastUpdatedByLightboxDocumentIdOrganizationNamePersonFirstNamePersonLastNamePersonNamePersonTitleReportsToSharedDateSharedUserPartyId
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/lightboxDocumentsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
LightboxDocumentByIdfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CurrencyCode, notcurrencycode. - 31 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.