Branches

Search Branches

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

Searches branches by name/title. Provide up to 50 projectIds, or omit them to search all your own projects — or another owner's accessible projects via userId.

get/branches

Request

Base URL
https://api.crowdin.com/api/v2
Auth
none declared
TypeScript
https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/branches/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filterstring required

Search branches 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). All projects must belong to the same owner. Optional — omit to search all your accessible projects.

userIdinteger

Owner (user) whose projects to search when projectIds is omitted. Only projects you own or manage are searched. Defaults to your own account.

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Matched branches

Example response

{
  "data": [
    {
      "data": {
        "id": 34,
        "projectId": 2,
        "name": "develop-master",
        "title": "Master branch",
        "createdAt": "2019-09-16T13:48:04+00:00",
        "updatedAt": "2019-09-19T13:25:27+00:00",
        "exportPattern": "%three_letters_code%",
        "priority": "normal"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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