CRcrowdin
Source Files

List Directories

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

get/projects/{projectId}/directories

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Query parameters

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

Read more about sorting rules

branchIdinteger

Filter directories by branchId

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

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

directoryIdinteger

Filter directories by directoryId

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

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

filterstring

Filter directories by name

recursionboolean

Use to list directories 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

List project directories

Example response

{
  "data": [
    {
      "data": {
        "id": 4,
        "projectId": 2,
        "branchId": 34,
        "name": "main",
        "title": "<Description materials>",
        "exportPattern": "/localization/%locale%/%file_name%",
        "path": "/main",
        "priority": "normal",
        "createdAt": "2019-09-19T14:14:00+00:00",
        "updatedAt": "2019-09-19T14:14:00+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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