Files

Get a file's details

The owner's detail view of one file - identifiers, settings, counters, contentVersion and the revisions replacement history (the only place it is populated). Scope files:read; UUID or short id. A file you do not own, and an unclaimed anonymous file, answer 404, never 403.

get/api/v1/files/{uuid}

Request

  • Base URL: https://everypage.co
  • URL: https://everypage.co/api/v1/files/{uuid}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://everypage.co/oauth/authorize, token URL https://everypage.co/oauth/token, scopes: files:read)

Response

File details

uuidstring uuid
shortIdstring

Short share-URL alias; absent on files created before short IDs.

slugstring

Vanity link name (Pro); absent unless set. Resolves only on the owner's custom domain.

originalNamestring
sizeinteger

Bytes

mimeTypestring
createdAtstring date-time
updatedAtstring date-time
deleteAtstring date-time

Absent when the file never expires.

viewCountinteger
totalPagesinteger
viewerMode'standard' | 'flipbook' | 'swipe' | 'magazine'
protectedboolean

True if a password is set.

allowDownloadboolean
requireEmailboolean
notifyOnViewboolean
commentsEnabledboolean

Reader feedback notes are on (Pro to enable).

commentsAllowPublicboolean

Commenters may opt into public display of their note.

notifyOnCommentboolean

The owner is emailed (throttled) when a note arrives.

askReceiptboolean

Viewers are asked to confirm receipt (Basic+ to enable).

showExpiryboolean

Readers see a live "Expires in" countdown next to Download (default true, every plan). When false the public share-link metadata omits the expiry instant entirely.

marksEnabledboolean

Proofing page marks are on (Pro to enable).

annotationsEnabledboolean

Proofing annotations are on (Pro to enable).

viewLimitinteger

Self-destruct cap (Basic+). Absent when unlimited.

viewsConsumedinteger

Views consumed against viewLimit (always present, 0 when no limit).

burnedAtstring date-time

Present once the view-limit sweep destroyed the blob; the row and its readership survive, and content replacement un-burns it.

gateDomainsstring[]

Email-gate domain allowlist (Pro). Absent when any domain is accepted.

gateHeadingstring

The owner's heading for the gate card readers see before the document opens (Pro). Absent when the default wording applies.

gateMessagestring

The owner's explanatory line on the gate card (Pro). Absent when the default wording applies.

watermarkboolean

Viewer pages are stamped with the reader identity (Pro).

viewerSettingsobject

The stored appearance/behaviour blob exactly as saved (see the FileSettings.viewerSettings description); {} when never customised. Always present for the owner regardless of current plan.

shareDomainstring

The owner's verified Pro custom domain that share links and embeds are built on. Absent when links use everypage.co.

folderIdstring uuid

UUID of the folder the file is filed in. Absent when unfiled.

anonShareableboolean

True for owner-less files that are public-by-link (browser anonymous uploads, Canva imports). Always false once claimed.

contentVersioninteger

Counts in-place content replacements (1 = the original upload).

palettestring[]

Colour palette extracted from the document at import time: hex swatches ("#rrggbb"), dominant colour first, at most 6. ADVISORY ONLY - extraction is best-effort (first-page embedded raster images, short time budget), so the field is simply absent for vector-only documents, for files uploaded through non-import paths, for files created before the feature, and whenever extraction fails or times out. Absence is normal, never an error; use the palette for theming (e.g. styling a share card), never for logic.

canvaDesignIdstring

The Canva design this file was published from. Absent on files with no design binding (including after a detach).

canvaUpdatesEnabledboolean

Whether a Canva-side republish of the bound design may replace this file's bytes (see the setting). Present only alongside canvaDesignId.

Example response

{
  "shortId": "aB3xY9kQ2mZ7",
  "slug": "2026-pricing",
  "originalName": "proposal.pdf",
  "mimeType": "application/pdf",
  "shareDomain": "docs.example.com",
  "palette": [
    "#1a2b3c"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.