API V2 (Beta) · HubSpot Integrations
Pull from HubSpot
curl --request POST \ --url https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "resource_ids": [ "rc_0197c8f2-5a6b-7cde-8f12-3456789abcde" ], "language_codes": [ "de" ]}'import requests
url = "https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull"
payload = { "resource_ids": ["rc_0197c8f2-5a6b-7cde-8f12-3456789abcde"], "language_codes": ["de"]}headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull';const options = { method: 'POST', headers: {Authorization: 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json'}, body: '{"resource_ids":["rc_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"language_codes":["de"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull"
payload := strings.NewReader("{\n \"resource_ids\": [\n \"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"language_codes\": [\n \"de\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");RequestBody body = RequestBody.create(mediaType, "{\n \"resource_ids\": [\n \"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"language_codes\": [\n \"de\"\n ]\n}");Request request = new Request.Builder() .url("https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull") .post(body) .addHeader("Authorization", "Bearer YOUR_API_KEY") .addHeader("Content-Type", "application/json") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull', [ 'body' => '{ "resource_ids": [ "rc_0197c8f2-5a6b-7cde-8f12-3456789abcde" ], "language_codes": [ "de" ]}', 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', 'Content-Type' => 'application/json', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Post.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'request["Content-Type"] = 'application/json'request.body = "{\n \"resource_ids\": [\n \"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"language_codes\": [\n \"de\"\n ]\n}"
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.lingohub.com/v2/projects/PROJECT_ID/integrations/hubspot/pull"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, }, Content = new StringContent("{\n \"resource_ids\": [\n \"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"language_codes\": [\n \"de\"\n ]\n}") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Pulls the project’s HubSpot content items into its default branch in the background, all of them or the resource_ids and language_codes you choose; poll the import at the URL in Location. To pick up newly selected content items or remove deselected ones, use the sync instead. Requires stack-level resource management permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde
Header Parameters
Section titled “Header Parameters”Optional. A unique key of 1 to 255 characters, for example a UUID, that makes a retry of this request safe: a retry with the same key and the same request returns the first result instead of running the operation again. See Safe retries.
Request Body
Section titled “Request Body”Request body to pull or push resources through the existing content integration.
object
Resource selection in the project’s current default branch. Null or an empty list selects all eligible resources, preserving the provider workflow. Duplicate identities are rejected.
Example
[ "rc_0197c8f2-5a6b-7cde-8f12-3456789abcde"]Language selection from the current default branch. Null or an empty list uses all eligible languages according to the provider workflow. Duplicate codes are rejected.
Example
[ "de"]Responses
Section titled “Responses”The pull is queued.
An import scheduled for asynchronous processing.
object
The import this job is processing.
object
Always IMPORT.
Unique identifier of the import.
Unique identifier of the branch the import belongs to.
Status of the import. SKIPPED means an integration found nothing to import.
Why the import failed, was partly successful or was skipped; null when there is nothing to explain.
A machine-readable explanation of a background operation or entry outcome. The detail is safe display text, not a value to parse. A failed or partial operation may already have applied changes; inspect its entries before retrying.
object
Stable public outcome code.
English explanation of the outcome.
The git branch and commit a git pull read its files from; null for other imports.
Repository head observed before this pull listed its files. Files are fetched through a mutable branch, so this is not an exact content-snapshot guarantee or a success flag. Imports without a complete retained observation, including ordinary uploads and historical jobs, have null git_source. Processing, partial and failed imports can retain an observation; inspect status and entries. A retry can replace the observation after another head read, or retain a previous observation if it fails earlier. Separate jobs retain independent observations. Reads never contact the provider or infer metadata from the current branch binding.
object
Head SHA returned by the provider before the pull listed files.
Resolved remote branch used by this pull; independent of the LingoHub branch display name.
Number of texts the import created: one for each imported language of each new segment. 0 until the import finishes, and 0 when it failed.
Number of texts whose content or status the import changed, in every language, including target texts marked outdated because their source changed. 0 until the import finishes, and 0 when it failed.
Number of keys the import deactivated because their file no longer contains them. 0 until the import finishes, and 0 when it failed.
Number of deactivated keys the import reactivated because their file contains them again. 0 until the import finishes, and 0 when it failed.
Number of keys the import renamed or moved to another file. 0 until the import finishes, and 0 when it failed.
Timestamp when the import was created.
Timestamp when the import was last updated.
Always IMPORT.
Always JOB.
Example
{ "object_type": "JOB", "job_type": "IMPORT", "data": { "object_type": "IMPORT", "id": "rin_0197c8f2-5a6b-7cde-8f12-3456789abcde", "branch_id": "prb_0197c8f2-5a6b-7cde-8f12-3456789abcde", "status": "QUEUED", "status_details": null, "git_source": null, "texts_created": 0, "texts_updated": 0, "keys_deactivated": 0, "keys_reactivated": 0, "keys_renamed": 0, "created_at": "2026-01-15T10:30:00.123Z", "updated_at": "2026-01-15T10:30:00.123Z" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
True when the original successful result was replayed for this key.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
URL of the import to poll.
The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
Invalid or missing API key.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Insufficient permissions.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The resource does not exist, or the API key cannot see it.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
branch_not_ready: the default branch is still being created. An unresolved request returns idempotency_outcome_unknown without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (idempotency_key_in_use); retry after the number of seconds in the Retry-After header.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”Seconds to wait for an in-progress keyed request; absent for other conflicts.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The request exceeds the body or upload limit; no operation was performed.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The request is well-formed, but values are invalid; errors points at each of them.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”Seconds to wait before retrying.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
An unexpected internal server error occurred.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”Seconds to wait before retrying.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.