Skip to content

API V2 (Beta) · Stack Member Permissions

Retrieve effective stack member permissions

GET
/v2/stacks/{stackId}/member-permissions/{memberId}
curl --request GET \
--url https://api.lingohub.com/v2/stacks/STACK_ID/member-permissions/MEMBER_ID \
--header 'Authorization: Bearer YOUR_API_KEY'

Shows what a workspace member can actually do in the stack: access from their workspace role, their stack role and the default language permissions, also for members who weren’t added to the stack explicitly. It only reads; nothing changes. Requires stack-level settings management permission.

stackId
required

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde

string
memberId
required

Public id composed of the resource type prefix and its UUID.

string

Effective member permissions retrieved successfully.

Media typeapplication/json

Computed application permissions of a workspace member on one stack, including inherited access without an explicit assignment. These are not the calling API key’s permissions or an exception to API owner-mutation restrictions. Computed data has no invented timestamps.

object
object_type
required

Always STACK_MEMBER_PERMISSIONS.

string
Allowed values: STACK_MEMBER_PERMISSIONS
id
required

Workspace membership identity, addressed together with the stack.

string
>= 1 characters
stack_id
required

Stack on which the permissions are evaluated.

string
permissions
required

Effective access for every stack permission target, evaluated by the application’s authorization checks.

Array<object>

The access level the represented principal has to one area, in the vocabulary of required_permission in 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level granted.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE
language_permissions
required

Effective access for each current stack language, including inherited defaults. NO_ACCESS means the language checks grant no access; an empty map means the stack has no languages.

object
key
additional properties

Effective member language access after stack text permissions and language defaults are evaluated.

string
Allowed values: NO_ACCESS READ_ACCESS RESTRICTED_ACCESS FULL_ACCESS

Example

{
"object_type": "STACK_MEMBER_PERMISSIONS",
"id": "wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"stack_id": "stack_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"permissions": [
{
"scope": "STACK",
"target": "RESOURCES",
"level": "VIEW"
}
],
"language_permissions": {
"de": "READ_ACCESS"
}
}
ETag
string

Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.

RateLimit
string

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.

RateLimit-Policy
string

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 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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
RateLimit
string

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.

RateLimit-Policy
string

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
RateLimit
string

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.

RateLimit-Policy
string

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
RateLimit
string

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.

RateLimit-Policy
string

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
Retry-After
integer format: int32

Seconds to wait before retrying.

RateLimit
string

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.

RateLimit-Policy
string

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
RateLimit
string

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.

RateLimit-Policy
string

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.

Media typeapplication/problem+json

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
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

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
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

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"
}
}
Retry-After
integer format: int32

Seconds to wait before retrying.

RateLimit
string

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.

RateLimit-Policy
string

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.