CRcrowdin
Source Files

List Files

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

get/projects/{projectId}/files

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Query parameters

orderBy'id' | 'name' | 'title' | 'status' | 'exportPattern' | 'priority' | 'createdAt' | 'updatedAt'

Read more about sorting rules

branchIdinteger

List branch files

Note: Can't be used with directoryId in the same request.

To list the files from all the nested levels within the branch, ensure to use the recursion parameter with the branchId parameter.

directoryIdinteger

List directory files

Note: Can't be used with branchId in the same request.

To list the files from all the nested levels within the directory, ensure to use the recursion parameter with the directoryId parameter.

filterstring

Filter files by name

recursionboolean

Use to list files recursively

Note: Works only when directoryId or branchId parameter is specified

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Project files list

  • Translators and proofreaders – receive the response File Info Resource
  • Project owners, organization admins, and managers – receive the response File Resource
OR

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",
        "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.