Source Files

Search Files

Required scopes: project.source.file (Read only).

Searches source files by name/title. Provide up to 50 projectIds, or omit them to search all projects you can access in the organization.

get/files

Request

Query parameters

filterstring required

Search files by name or title

projectIdsstring

Project identifiers to search across. Get via List Projects. It can be one project or a list of comma-separated ones (max 50). Optional — omit to search all projects you can access in the organization.

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Matched files

Example response

{
  "data": [
    {
      "data": {
        "id": 44,
        "projectId": 2,
        "branchId": 34,
        "directoryId": 4,
        "name": "umbrella_app.xliff",
        "title": "source_app_info",
        "context": "Context for translators",
        "type": "xliff",
        "path": "/directory1/directory2/filename.extension",
        "status": "active",
        "revisionId": 1,
        "priority": "normal",
        "importOptions": {
          "scheme": {
            "identifier": 0,
            "sourcePhrase": 1,
            "en": 2,
            "de": 3
          }
        },
        "exportOptions": {
          "exportPattern": "/localization/%locale%/%file_name%.%file_extension%"
        },
        "excludedTargetLanguages": [
          "en",
          "es",
          "pl"
        ],
        "parserVersion": 12,
        "createdAt": "2019-09-19T15:10:43+00:00",
        "updatedAt": "2019-09-19T15:10:46+00:00",
        "fields": {
          "some-field-1": "some value 1",
          "some-field-2": 12,
          "some-field-3": true,
          "some-field-4": [
            "en",
            "ja"
          ]
        }
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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