GuidesAPIChangelogStatus
API
Sign InSign Up

Retrieve file metadata

get
https://apps.inkit.com/api/v1/files/retrieve/

Get metadata for a specific file by its public ID.

This endpoint accepts multiple types of public IDs:

  • File ID (prefix: file_) - Retrieve by file public ID
  • Render Data ID (prefix: rend_) - Retrieve by render data public ID
  • Document ID (prefix: doc_) - Retrieve by document public ID
Path Params
string
required

Public ID of the file, render data, document, or template. Accepted prefixes: file_, rend_, doc_

Headers
string
required

API Key for authentication

Responses

Updated 3 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago