List Files

Get a List of Files

get

Retrieves a paginated and filterable list of files.

Authorizations

bearerAuth

AuthorizationstringRequired

The File Management API uses JWT (JSON Web Tokens) for authentication.

Obtaining a Token

To retrieve a valid token, you must call the login/idm/tokens endpoint.

• Requirements: Use a Service Account that has been assigned the Content Export Reader role.
• Response: The JWT will be returned in the access_token field of the JSON response.
• Reference: For detailed steps on the handshake, see the OAuth2 Authenticate documentation.

Using the Token

Once obtained, include the token in the Authorization header for all API requests: Authorization: Bearer <access_token>

Error Codes

• 401 Unauthorized: Token is missing, expired, or invalid.
• 403 Forbidden: Authenticated but lacks the Content Export Reader role.

Query parameters

typestring · enumRequired

The type of file being managed.

Possible values:

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

pageSizeinteger · min: 1 · max: 100Optional

Number of files per page (max 100).

Default: 10

sortBystring · enumOptional

Indicates how the answer will be sorted.

Possible values:

sortOrderstring · enumOptional

Sort order.

Default: ascPossible values:

namestringOptional

Filter files by name. Supports partial matching (case-insensitive).

Example: {"value":"POD_ID"}

upload-afterstring · date-timeOptional

Filter by upload timestamp greater than (ISO 8601).

upload-beforestring · date-timeOptional

Filter by upload timestamp less than (ISO 8601).

jobTypestring · enumOptional

Indicates how the file was submitted.

Example: ADHOCPossible values:

fileFormatstring · enumOptional

Content export format.

Example: SymphonyPossible values:

startTime-afterstring · date-timeOptional

Filter by start timestamp greater than (ISO 8601). Only applicable when type=ContentExport.

endTime-beforestring · date-timeOptional

Filter by end timestamp less than (ISO 8601). Only applicable when type=ContentExport.

generationDatestring · dateOptional

Filter by generation date. Only applicable when type=ContentExport.

Responses

200

A list of files.

application/json

400

Bad Request - Invalid query parameters.

application/json

401

Unauthorized - Authentication failed.

application/json

403

Forbidden - Invalid entitlements.

application/json

500

Internal Server Error.

application/json

get

/files/v1/

HTTPcURLJavaScriptPython

GET /files/v1/?type=ContentExport HTTP/1.1
Host: yourpodURL.symphony.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "internal_file_id_1",
    "name": "s_POD_ID_SD-2025-01-01-00_ED-2025-05-12-09_GD-2025-05-12_1747050746368.zip.pgp",
    "size": 1234567,
    "uploadTime": "2024-05-15T10:00:00Z",
    "contentType": "application/pgp-encrypted",
    "integrityHash": "e79e8e823f2df5091d1e4e1583816c07977d3f11b676f91c9f8dcc53c26e271d",
    "type": "ContentExport",
    "encryption": {
      "encryptionKeyId": "key_123",
      "alg": "AES256-GCM"
    },
    "typeSpecificMetadata": {
      "jobType": "ADHOC",
      "fileFormat": "Symphony",
      "startTime": "2024-05-10T14:30:00Z",
      "endTime": "2025-05-12-09T14:30:00Z",
      "generationDate": "2025-05-12"
    }
  },
  {
    "id": "internal_file_id_2",
    "name": "s_POD_ID_CD-2024-10-23_GD-2024-11-08_1731059488177.zip.pgp",
    "size": 876543,
    "uploadTime": "2024-05-10T14:30:00Z",
    "contentType": "application/pgp-encrypted",
    "integrityHash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
    "type": "ContentExport",
    "encryption": {
      "encryptionKeyId": "key_456",
      "alg": "AES256-GCM"
    },
    "typeSpecificMetadata": {
      "jobType": "SCHEDULED",
      "fileFormat": "Actiance",
      "startTime": "2024-10-23T14:30:00Z",
      "endTime": "2024-11-08T14:30:00Z",
      "generationDate": "2024-11-08"
    }
  }
]