REST API
Files
Use the REST API to fetch files data and retrieve submission information.
About Files
Access any file that belongs to you through our API endpoint. Retrieve file metadata, submission counts, and all associated form submissions in a single request.
Parameters for "Get file data"
Body Parameters
fileIdstringRequiredThe file id of which you want to get data for.
apiKeystringRequiredThe API key for the user that can be created in the users settings.
HTTP Response Status Codes
| Status Code | Description |
|---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Code Sample
POST/api/v1/file-data
cURL
curl --location 'https://www.pdf.fides-solutions.io/api/v1/file-data' \ --header 'Content-Type: application/json' \ --data '{"fileId": "<YOUR-FILE-ID>","apiKey": "<YOUR-API-TOKEN>"}'Response
Example Response200 OK
{"name": "file for api","creationDate": "2023-12-04T23:58:22.571Z","publicAvailability": true,"SubmissionCounter": 2,"VisitCounter": 2,"submissions": [{"createdDate": "2023-12-09T17:05:13.207Z","content": {"Name": "James","Lastname": "Smith"}},{"createdDate": "2023-12-09T17:05:29.990Z","content": {"Name": "Tom","Lastname": "Smith"}}]}