Crowdin Apps

https://support.crowdin.com/developer/
Admin
Crowdin Apps allow developers to extend and customize the Crowdin localization management platform...
Tokens:1,020,981
Snippets:5,209
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get Application Settings - Response sample

Source: https://support.crowdin.com/developer/api/v2

Example response for get application settings, showing schedule and condition values.

```json
{
  "data": {
    "schedule": 0,
    "condition": 0
  }
}
```

--------------------------------

### List Application Installations - Response 200

Source: https://support.crowdin.com/developer/api/v2/string-based

Example JSON response for a successful request (HTTP 200). Contains the application installation list with metadata, permissions, and pagination details.

```json
{
  "data": [
    {
      "data": {
        "identifier": "example-application",
        "name": "Application name",
        "installedBy": {
          "id": 12,
          "username": "john_smith",
          "fullName": "John Smith",
          "avatarUrl": ""
        },
        "description": "Application description",
        "logo": "/resources/images/logo.png",
        "logoUrl": "https://localhost.dev/resources/images/logo.png",
        "agent": {
          "id": 12,
          "username": "john_smith",
          "fullName": "John Smith",
          "avatarUrl": ""
        },
        "baseUrl": "https://localhost.dev",
        "manifestUrl": "https://localhost.dev",
        "manifest": { },
        "createdAt": "2019-09-20T11:34:40+00:00",
        "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
        "isManifestOutdated": false,
        "modules": [
          {
            "key": "example-application",
            "type": "module-type",
            "data": { },
            "permissions": {
              "user": {
                "value": "restricted",
                "ids": [
                  1
                ]
              }
            },
            "authenticationType": "none"
          }
        ],
        "scopes": [
          "project"
        ],
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [
              1
            ]
          },
          "project": {
            "value": "restricted",
            "ids": [
              1
            ]
          }
        },
        "defaultPermissions": {
          "user": "owner",
          "project": "own"
        },
        "limitReached": true,
        "stringBasedAvailable": false,
        "bundle": {
          "mode": "internal"
        }
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 25
  }
}
```

--------------------------------

### GET /applications/installations/{identifier}

Source: https://support.crowdin.com/developer/api/v2/string-based

Fetches the installation data for the application installation identified by the given identifier. The response includes metadata about the installation, such as the installed-by user, agent, manifest, modules, and permissions.

```APIDOC
## GET /applications/installations/{identifier}

### Description
Fetches the installation data for the application installation identified by the given identifier. The response includes metadata about the installation, such as the installed-by user, agent, manifest, modules, and permissions.

### Method
GET

### Endpoint
{protocol}://{host}/api/v2/applications/installations/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - Application Identifier. Get via List Applications.

### Response
#### Success Response (200)
Application installation data

#### Response Example
```json
{
  "data": {
    "identifier": "example-application",
    "name": "Application name",
    "installedBy": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "description": "Application description",
    "logo": "/resources/images/logo.png",
    "logoUrl": "https://localhost.dev/resources/images/logo.png",
    "agent": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "baseUrl": "https://localhost.dev",
    "manifestUrl": "https://localhost.dev",
    "manifest": {},
    "createdAt": "2019-09-20T11:34:40+00:00",
    "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
    "isManifestOutdated": false,
    "modules": [
      {
        "key": "example-application",
        "type": "module-type",
        "data": {},
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [1]
          }
        },
        "authenticationType": "none"
      }
    ],
    "scopes": ["project"],
    "permissions": {
      "user": {
        "value": "restricted",
        "ids": [1]
      },
      "project": {
        "value": "restricted",
        "ids": [1]
      }
    },
    "defaultPermissions": {
      "user": "owner",
      "project": "own"
    },
    "limitReached": true,
    "stringBasedAvailable": false,
    "bundle": {
      "mode": "internal"
    }
  }
}
```

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Application installation with specified identifier was not found
- **405** - Method Not Allowed
```

--------------------------------

### Install Application Request Payload (JSON)

Source: https://support.crowdin.com/developer/api/v2/string-based

Example request body for installing an application from a manifest URL. Requires the application.installation scope with Read and Write permissions. The manifestHash must match the current manifest at the URL, otherwise the installation is rejected with 409.

```json
{
  "url": "https://localhost.dev/crowdin.json",
  "permissions": {
    "user": {
      "value": "restricted",
      "ids": [
        1
      ]
    },
    "project": {
      "value": "restricted",
      "ids": [
        1
      ]
    }
  },
  "modules": [
    {
      "key": "some-module-key",
      "permissions": {
        "user": {
          "value": "restricted",
          "ids": [
            1
          ]
        }
      }
    }
  ],
  "assignAgent": false,
  "manifestHash": "5536b952d54e0846b6fd69217f6eb7cfdcfba41774732926e1f0c1a158a6e405"
}
```

--------------------------------

### Self-Hosted App Descriptor Example

Source: https://support.crowdin.com/developer/crowdin-apps-app-descriptor

Example manifest.json for a self-hosted app. Includes baseUrl, authentication, events, and project-integrations module. All URLs are relative to baseUrl and must start with '/'. baseUrl must start with https:// and cannot change after installation.

```json
{
  "identifier": "your-application-identifier",
  "name": "Your Application",
  "description": "Application description",
  "logo": "/assets/logos/app-logo.png",
  "baseUrl": "https://example.com",
  "authentication": {
    "type": "crowdin_app",
    "clientId": "your-client-id"
  },
  "events": {
    "installed": "/hooks/installed"
  },
  "scopes": [
    "project"
  ],
  "modules": {
    "project-integrations": [
      {
        "key": "your-module-key",
        "name": "Module Name",
        "description": "Module description",
        "logo": "/assets/logos/module-logo.png",
        "url": "/page/integration",
        "environments": [
          "crowdin", "crowdin-enterprise"
        ]
      }
    ]
  }
}
```

--------------------------------

### Get Sync Settings - Response sample

Source: https://support.crowdin.com/developer/api/v2

Example response for get sync settings, showing file IDs mapped to language codes.

```json
{
  "data": {
    "102": [
      "uk",
      "de"
    ]
  }
}
```

--------------------------------

### Get File - Response Example (CrowdinFileInfoResource)

Source: https://support.crowdin.com/developer/api/v2

Example JSON response for a successful request (200). Shows the file metadata including id, projectId, branchId, directoryId, name, title, context, type, path, and status.

```json
{
  "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"
  }
}
```

--------------------------------

### GET /style-guides/{styleGuideId}

Source: https://support.crowdin.com/developer/api/v2/string-based

Retrieves a style guide by its unique identifier. Requires the 'style-guide' scope with read-only permission. Returns the style guide data including name, AI instructions, associated languages and projects, and download link.

```APIDOC
## GET /style-guides/{styleGuideId}

### Description
Retrieves a style guide by its unique identifier.

### Method
GET

### Endpoint
{protocol}://{host}/api/v2/style-guides/{styleGuideId}

### Parameters
#### Path Parameters
- **styleGuideId** (integer <int32>) - Required - Style Guide Identifier

### Response
#### Success Response (200)
Style Guide data

#### Response Example
```json
{
  "data": {
    "id": 2,
    "name": "Be My Eyes iOS's Style Guide",
    "aiInstructions": "Rules to be used by AI models",
    "userId": 2,
    "languageIds": ["uk", "fr", "de"],
    "projectIds": [6],
    "isShared": false,
    "webUrl": "https://crowdin.com/profile/{userName}/style-guides?id=1",
    "downloadLink": "https://storage.crowdin.com/style-guide/123/456/file.pdf",
    "createdAt": "2019-09-16T13:42:04+00:00",
    "updatedAt": "2019-09-16T13:42:04+00:00"
  }
}
```

#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Style Guide with specified id was not found
- **405** Method Not Allowed
```

--------------------------------

### GET /users/{userId}/ai/settings - Response 200

Source: https://support.crowdin.com/developer/api/v2/string-based

Example JSON response for a successful GET request. Contains AI prompt IDs, cost limits, and per-user overrides.

```json
{
  "data": {
    "preTranslationAiPromptId": 2,
    "editorSuggestionAiPromptId": 5,
    "qaCheckActionAiPromptId": 8,
    "contextReviewAiPromptId": 11,
    "dailyCostLimit": 100,
    "monthlyCostLimit": 2000,
    "userDailyCostLimit": 10,
    "userMonthlyCostLimit": 200,
    "isLimitingActive": true,
    "perUserOverrides": [
      {
        "userId": 123,
        "costLimitMode": "custom",
        "dailyCostLimit": 5,
        "monthlyCostLimit": 100,
        "createdAt": "2026-05-23T11:26:54+00:00",
        "updatedAt": "2026-05-23T11:26:54+00:00"
      }
    ]
  }
}
```

--------------------------------

### List Application Installations - Request

Source: https://support.crowdin.com/developer/api/v2/string-based

HTTP GET request to retrieve application installations. Requires the `application.installation` scope (read only). Supports query parameters: `limit` (1-500, default 25), `offset` (>=0, default 0), `installedBy` (user ID), and `orderBy` (e.g., `createdAt desc`).

```http
get/applications/installations
```

--------------------------------

### GET /applications/installations

Source: https://support.crowdin.com/developer/api/v2/string-based

Retrieves a list of application installations. Supports pagination, filtering by installer, and sorting.

```APIDOC
## GET /applications/installations

### Description
Retrieves a list of application installations. Supports pagination, filtering by installer, and sorting.

### Method
GET

### Endpoint
{protocol}://{host}/api/v2/applications/installations

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - A maximum number of items to retrieve. Range: 1-500. Default: 25.
- **offset** (integer) - Optional - A starting offset in the collection. Must be >= 0. Default: 0.
- **installedBy** (integer) - Optional - User Identifier.
- **orderBy** (string) - Optional - Sorting rules. Enum: "id", "createdAt". Example: orderBy=createdAt desc.

### Response
#### Success Response (200)
Application Installation list

#### Response Example
```json
{
  "data": [
    {
      "data": {
        "identifier": "example-application",
        "name": "Application name",
        "installedBy": {
          "id": 12,
          "username": "john_smith",
          "fullName": "John Smith",
          "avatarUrl": ""
        },
        "description": "Application description",
        "logo": "/resources/images/logo.png",
        "logoUrl": "https://localhost.dev/resources/images/logo.png",
        "agent": {
          "id": 12,
          "username": "john_smith",
          "fullName": "John Smith",
          "avatarUrl": ""
        },
        "baseUrl": "https://localhost.dev",
        "manifestUrl": "https://localhost.dev",
        "manifest": {},
        "createdAt": "2019-09-20T11:34:40+00:00",
        "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
        "isManifestOutdated": false,
        "modules": [
          {
            "key": "example-application",
            "type": "module-type",
            "data": {},
            "permissions": {
              "user": {
                "value": "restricted",
                "ids": [1]
              }
            },
            "authenticationType": "none"
          }
        ],
        "scopes": ["project"],
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [1]
          },
          "project": {
            "value": "restricted",
            "ids": [1]
          }
        },
        "defaultPermissions": {
          "user": "owner",
          "project": "own"
        },
        "limitReached": true,
        "stringBasedAvailable": false,
        "bundle": {
          "mode": "internal"
        }
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 25
  }
}
```

#### Error Responses
- **400** - Invalid Request Parameters
- **401** - Unauthorized
- **403** - Forbidden
- **405** - Method Not Allowed
```

--------------------------------

### POST /applications/installations

Source: https://support.crowdin.com/developer/api/v2/string-based

Installs an application from a manifest URL or manifest content. Requires the 'application.installation' scope with Read and Write permissions.

```APIDOC
## POST /applications/installations

### Description
Installs an application either from a hosted manifest URL or from its manifest content. Requires the `application.installation` scope with Read and Write permissions.

### Method
POST

### Endpoint
{protocol}://{host}/api/v2/applications/installations

### Parameters
#### Request Body
- **url** (string) - Required - Manifest URL. Required when installing from a manifest URL.
- **permissions** (object) - Optional - Permissions for the application.
- **modules** (Array of objects) - Optional - Modules to install.
- **assignAgent** (boolean) - Optional - Default: false. Assign Agent as a manager to all existing projects.
- **manifestHash** (string) - Optional - Hash of the app manifest as it was loaded for review before installation. If provided and the manifest currently served at `url` differs, the installation is rejected with 409 and nothing is installed.

### Request Example
```json
{
  "url": "https://localhost.dev/crowdin.json",
  "permissions": {
    "user": {
      "value": "restricted",
      "ids": [1]
    },
    "project": {
      "value": "restricted",
      "ids": [1]
    }
  },
  "modules": [
    {
      "key": "some-module-key",
      "permissions": {
        "user": {
          "value": "restricted",
          "ids": [1]
        }
      }
    }
  ],
  "assignAgent": false,
  "manifestHash": "5536b952d54e0846b6fd69217f6eb7cfdcfba41774732926e1f0c1a158a6e405"
}
```

### Response
#### Success Response (201)
Application Installation was successfully created.

#### Response Example
```json
{
  "data": {
    "identifier": "example-application",
    "name": "Application name",
    "installedBy": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "description": "Application description",
    "logo": "/resources/images/logo.png",
    "logoUrl": "https://localhost.dev/resources/images/logo.png",
    "agent": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "baseUrl": "https://localhost.dev",
    "manifestUrl": "https://localhost.dev",
    "manifest": {},
    "createdAt": "2019-09-20T11:34:40+00:00",
    "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
    "isManifestOutdated": false,
    "modules": [
      {
        "key": "example-application",
        "type": "module-type",
        "data": {},
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [1]
          }
        },
        "authenticationType": "none"
      }
    ],
    "scopes": ["project"],
    "permissions": {
      "user": {
        "value": "restricted",
        "ids": [1]
      },
      "project": {
        "value": "restricted",
        "ids": [1]
      }
    },
    "defaultPermissions": {
      "user": "owner",
      "project": "own"
    },
    "limitReached": true,
    "stringBasedAvailable": false,
    "bundle": {
      "mode": "internal"
    }
  }
}
```

### Error Responses
- **400** - Invalid Request Parameters
- **401** - Unauthorized
- **403** - Forbidden
- **405** - Method Not Allowed
- **409** - The manifest at `url` no longer matches `manifestHash`
```

--------------------------------

### Install and use the Crowdin Serverless Apps CLI

Source: https://support.crowdin.com/developer/crowdin-apps-serverless

Commands to install the CLI globally, log in, create a new app, run it locally, preview it, and publish it. The CLI scaffolds the app, runs it locally, and publishes it.

```bash
npm install --global @crowdin/serverless-apps-cli
crowdin-serverless-apps login
crowdin-serverless-apps create my-app
crowdin-serverless-apps dev
crowdin-serverless-apps preview
crowdin-serverless-apps publish
```

--------------------------------

### Response 201: Application Bundle Uploaded

Source: https://support.crowdin.com/developer/api/v2/string-based

Example response for a successful upload (HTTP 201). Contains application installation details including identifier, name, installedBy, agent, manifest, modules, scopes, permissions, and bundle mode.

```json
{
  "data": {
    "identifier": "example-application",
    "name": "Application name",
    "installedBy": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "description": "Application description",
    "logo": "/resources/images/logo.png",
    "logoUrl": "https://localhost.dev/resources/images/logo.png",
    "agent": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "baseUrl": "https://localhost.dev",
    "manifestUrl": "https://localhost.dev",
    "manifest": { },
    "createdAt": "2019-09-20T11:34:40+00:00",
    "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
    "isManifestOutdated": false,
    "modules": [
      {
        "key": "example-application",
        "type": "module-type",
        "data": { },
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [
              1
            ]
          }
        },
        "authenticationType": "none"
      }
    ],
    "scopes": [
      "project"
    ],
    "permissions": {
      "user": {
        "value": "restricted",
        "ids": [
          1
        ]
      },
      "project": {
        "value": "restricted",
        "ids": [
          1
        ]
      }
    },
    "defaultPermissions": {
      "user": "owner",
      "project": "own"
    },
    "limitReached": true,
    "stringBasedAvailable": false,
    "bundle": {
      "mode": "internal"
    }
  }
}
```

--------------------------------

### Get User Security Log - Response Example (200)

Source: https://support.crowdin.com/developer/api/v2

Example JSON response for the Get User Security Log endpoint. Shows the structure of a security log entry with fields like id, event, info, userId, location, ipAddress, deviceName, and createdAt.

```json
{
  "data": {
    "id": 2,
    "event": "Some event",
    "info": "Some info",
    "userId": 4,
    "location": "USA",
    "ipAddress": "127.0.0.1",
    "deviceName": "MacOs on MacBook",
    "createdAt": "2019-09-19T15:10:43+00:00"
  }
}
```

--------------------------------

### GET /applications/{applicationIdentifier}/api/sync-settings

Source: https://support.crowdin.com/developer/api/v2

Retrieves the sync settings for an application installation.

```APIDOC
## GET /applications/{applicationIdentifier}/api/sync-settings

### Description
Retrieves the sync settings for an application installation.

### Method
GET

### Endpoint
/applications/{applicationIdentifier}/api/sync-settings

### Parameters
#### Path Parameters
- **applicationIdentifier** (string) - Required - Identifier of the application. Get via List Application Installations.

#### Query Parameters
- **projectId** (integer) - Required - Project Identifier. Get via List Projects.
- **provider** (string) - Required - Enum: "crowdin" "integration".

### Response
#### Success Response (200)
Application Sync Settings.

#### Response Example
```json
{
  "data": {
    "102": ["uk", "de"]
  }
}
```
```

--------------------------------

### 201 Response Sample

Source: https://support.crowdin.com/developer/enterprise/api/v2/string-based

Example response for a successful project creation, showing the created project's data including id, groupId, type, userId, and identifier.

```json
{
  "data": {
    "id": 8,
    "groupId": 4,
    "type": 1,
    "userId": 6,
    "sourceLanguageId": "en",
    "targetLanguageIds": [
      "es"
    ],
    "name": "Knowledge Base",
    "identifier": "1f198a4e907688bc65834a6d5a6000c3",
    "description": "Vault of all terms and their explanation"
  }
}
```

--------------------------------

### POST /projects/{projectId}/translations/builds - 201 Response

Source: https://support.crowdin.com/developer/api/v2

Example response when the project build was successfully started. Shows the build object with status, progress, timestamps, and attributes.

```json
{
  "data": {
    "id": 2,
    "projectId": 2,
    "status": "finished",
    "progress": 100,
    "createdAt": "2019-09-19T15:10:43+00:00",
    "updatedAt": "2019-09-19T15:10:46+00:00",
    "finishedAt": "2019-09-19T15:10:46+00:00",
    "error": {
      "message": "Export failed: the exported file contains invalid data."
    },
    "attributes": {
      "branchId": 1,
      "directoryId": 1,
      "targetLanguageIds": [
        "en"
      ],
      "skipUntranslatedStrings": false,
      "skipUntranslatedFiles": false,
      "exportApprovedOnly": false
    }
  }
}
```

--------------------------------

### AP.project.previewTranslations example

Source: https://support.crowdin.com/developer/crowdin-apps-js

Triggers a preview download in the specified format. The example downloads a CSV preview.

```javascript
// Trigger a preview download in CSV format
AP.project.previewTranslations('csv');
```

--------------------------------

### Update Integration Files - files Example

Source: https://support.crowdin.com/developer/api/v2

Example of the files object mapping file IDs to language codes.

```json
{
 102: ["de", "fr"],
 999: ["uk"]
}
```

--------------------------------

### GET /api/v2/user - 200 Response

Source: https://support.crowdin.com/developer/api/v2/string-based

Example JSON response for a successful GET request to the authenticated user endpoint. Contains user profile fields such as id, username, email, and timezone.

```json
{
  "data": {
    "id": 12,
    "username": "john_smith",
    "email": "jsmith@example.com",
    "emailVerified": "false",
    "fullName": "John Smith",
    "avatarUrl": "",
    "createdAt": "2019-07-11T07:40:22+00:00",
    "lastSeen": "2019-10-23T11:44:02+00:00",
    "twoFactor": "enabled",
    "timezone": "Europe/Kyiv"
  }
}
```

--------------------------------

### POST /style-guides 201 Response

Source: https://support.crowdin.com/developer/api/v2/string-based

Successful response (201) for creating a style guide. Returns the created style guide object with id, name, aiInstructions, userId, languageIds, projectIds, isShared, webUrl, downloadLink, createdAt, and updatedAt.

```json
{
  "data": {
    "id": 2,
    "name": "Be My Eyes iOS's Style Guide",
    "aiInstructions": "Rules to be used by AI models",
    "userId": 2,
    "languageIds": [
      "uk",
      "fr",
      "de"
    ],
    "projectIds": [
      6
    ],
    "isShared": false,
    "webUrl": "https://crowdin.com/profile/{userName}/style-guides?id=1",
    "downloadLink": "https://storage.crowdin.com/style-guide/123/456/file.pdf",
    "createdAt": "2019-09-16T13:42:04+00:00",
    "updatedAt": "2019-09-16T13:42:04+00:00"
  }
}
```

--------------------------------

### GET /api/v2/user/tasks - 200 Response Example

Source: https://support.crowdin.com/developer/api/v2/string-based

Example JSON response for a successful request to list user tasks. Shows the structure of task data including assignees, progress, costs, and language details.

```json
{
  "data": [
    {
      "data": {
        "id": 2,
        "projectId": 2,
        "creatorId": 6,
        "type": 1,
        "status": "todo",
        "title": "French",
        "batchId": 1,
        "assignees": [
          {
            "id": 12,
            "username": "john_smith",
            "fullName": "John Smith",
            "avatarUrl": "",
            "wordsCount": 5,
            "wordsLeft": 3,
            "timeSpent": 3600
          }
        ],
        "assignedTeams": [
          {
            "id": 1,
            "wordsCount": 5,
            "timeSpent": 3600
          }
        ],
        "progress": {
          "total": 24,
          "done": 15,
          "percent": 62
        },
        "translateProgress": {
          "total": 24,
          "done": 15,
          "percent": 62
        },
        "sourceLanguageId": "en",
        "targetLanguageId": "fr",
        "description": "Proofread all French strings",
        "translationUrl": "/proofread/9092638ac9f2a2d1b5571d08edc53763/all/en-fr/10?task=dac37aff364d83899128e68afe0de4994",
        "webUrl": "https://crowdin.com/project/example-project/tasks/1",
        "wordsCount": 24,
        "originalWordsCount": 24,
        "commentsCount": 0,
        "deadline": "2019-09-27T07:00:14+00:00",
        "startedAt": "2019-09-27T07:00:14+00:00",
        "resolvedAt": "2019-09-27T07:00:14+00:00",
        "timeRange": "2019-08-23T09:04:29+00:00|2019-07-23T09:04:29+00:00",
        "translationsUpdatedTimeRange": "2025-06-23T09:04:29+00:00|2025-08-23T09:04:29+00:00",
        "workflowStepId": 10,
        "buyUrl": "https://www.paypal.com/cgi-bin/webscr?cmd=...",
        "createdAt": "2019-09-23T09:04:29+00:00",
        "updatedAt": "2019-09-23T09:04:29+00:00",
        "sourceLanguage": {
          "id": "es",
          "name": "Spanish",
          "editorCode": "es",
          "twoLettersCode": "es",
          "threeLettersCode": "spa",
          "locale": "es-ES",
          "androidCode": "es-rES",
          "bcp47Code": "b+es+ES",
          "osxCode": "es.lproj",
          "osxLocale": "es",
          "pluralCategoryNames": [
            "one"
          ],
          "pluralRules": "(n != 1)",
          "pluralExamples": [
            "0, 2-999; 1.2, 2.07..."
          ],
          "textDirection": "ltr",
          "dialectOf": "es"
        },
        "targetLanguages": [
          {
            "id": "es",
            "name": "Spanish",
            "editorCode": "es",
            "twoLettersCode": "es",
            "threeLettersCode": "spa",
            "locale": "es-ES",
            "androidCode": "es-rES",
            "bcp47Code": "b+es+ES",
            "osxCode": "es.lproj",
            "osxLocale": "es",
            "pluralCategoryNames": [
              "one"
            ],
            "pluralRules": "(n != 1)",
            "pluralExamples": [
              "0, 2-999; 1.2, 2.07..."
            ],
            "textDirection": "ltr",
            "dialectOf": "es"
          }
        ],
        "labelIds": [
          13,
          27
        ],
        "labelMatchRule": "all",
        "excludeLabelIds": [
          5,
          8
        ],
        "excludeLabelMatchRule": "all",
        "precedingTaskId": 1,
        "estimatedCost": {
          "cost": "24.12",
          "date": "2019-09-23T09:04:29+00:00",
          "currency": "USD"
        },
        "actualCost": {
          "cost": "24.12",
          "date": "2019-09-23T09:04:29+00:00",
          "currency": "USD"
        },
        "generateCostEstimate": true,
        "generateTranslationCost": true,
        "reportSettingsTemplateId": 1,
        "isArchived": false,
        "vendor": "gengo",
        "branchIds": [
          24,
          25,
          38
        ]
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 25
  }
}
```

--------------------------------

### Get Field - 200 Response

Source: https://support.crowdin.com/developer/enterprise/api/v2/string-based

Example response for a successful GET request to /fields/{fieldId}. Shows the field data structure including id, name, slug, description, type, config, entities, and timestamps.

```json
{
  "data": {
    "id": 2,
    "name": "Custom field",
    "slug": "custom-field",
    "description": "Custom field description",
    "type": "select",
    "config": { },
    "entities": [
      "task"
],
    "createdAt": "2019-09-23T09:04:29+00:00",
    "updatedAt": "2019-09-23T09:04:29+00:00"
}

}
```
Tokens:
Raw