Screenshots

List Screenshots

Required scopes: project.screenshot (Read only).

get/projects/{projectId}/screenshots

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Query parameters

searchstring

Search screenshots by name, tagged strings or file names that include screenshots.

orderBy'id' | 'name' | 'tagsCount' | 'createdAt' | 'updatedAt'

Read more about sorting rules

stringIdinteger

String Identifier. Get via List Strings.

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

stringIdsstring
Example:1,2,3,4,5

String Identifiers. Get via List Strings.

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

labelIdsstring
Example:1,2,3,4,5

Label Identifiers. Get via List Labels

excludeLabelIdsstring

Label Identifiers. Get via List Labels

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Screenshots list

Example response

{
  "data": [
    {
      "data": {
        "id": 2,
        "userId": 6,
        "url": "https://production-enterprise-screenshots.downloads.crowdin.com/992000002/6/2/middle.jpg?X-Amz-Content-Sha256={sha}&X-Amz-Algorithm={algorithm}&X-Amz-Credential={credentials}&X-Amz-Date={date}&X-Amz-SignedHeaders={headers}&X-Amz-Expires={expires}&X-Amz-Signature={signature}",
        "webUrl": "https://production-enterprise-screenshots.downloads.crowdin.com/992000002/6/2/middle.jpg?X-Amz-Content-Sha256={sha}&X-Amz-Algorithm={algorithm}&X-Amz-Credential={credentials}&X-Amz-Date={date}&X-Amz-SignedHeaders={headers}&X-Amz-Expires={expires}&X-Amz-Signature={signature}",
        "name": "translate_with_siri.jpg",
        "size": {
          "width": 267,
          "height": 176
        },
        "tagsCount": 1,
        "tags": [
          {
            "id": 98,
            "screenshotId": 2,
            "stringId": 2822,
            "position": {
              "x": 474,
              "y": 147,
              "width": 490,
              "height": 99
            },
            "createdAt": "2019-09-23T09:35:31+00:00"
          }
        ],
        "labels": [
          1
        ],
        "labelIds": [
          1
        ],
        "createdAt": "2019-09-23T09:29:19+00:00",
        "updatedAt": "2019-09-23T09:29:19+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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