Get role taxonomy version

Returns an immutable version of the Luranta role taxonomy.

GET/v0/taxonomies/roles/{version}

Authentication

bearerAuth · http bearer

Organisation API key supplied only through the Authorization header.

Required scopes: catalogues:read.

Parameters

Name	Type	Description
`version`required	stringpath	Positive immutable taxonomy version. Schema and examples `string` Positive immutable taxonomy version. Pattern `^[1-9]\d*$`

Responses

The requested role taxonomy snapshot.

application/json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

TaxonomySnapshotTaxonomySnapshot

Additional properties: forbidden

Properties

entriesrequired

object[]

Maximum items: 2000

Items

object

Additional properties: forbidden

Properties

aliasesrequired

string[]

Maximum items: 20

Items

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

boundary_notesrequired

string[]

Maximum items: 20

Items

string

Maximum length: 2000
Minimum length: 1

coderequired

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

definitionrequired

string | null

anyOf

Option 1

string

Maximum length: 2000
Minimum length: 1

Option 2

null

kindrequired

string

Allowed values: ["family","specialism","sector"]

labelrequired

string

Maximum length: 240
Minimum length: 1

labelsrequired

object

Additional property values

string

Maximum length: 240
Minimum length: 1

parent_coderequired

string | null

anyOf

Option 1

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

Option 2

null

replaced_byrequired

string | null

anyOf

Option 1

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

Option 2

null

statusrequired

string

Allowed values: ["active","deprecated"]

idrequired

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

objectrequired

string

Constant: taxonomy

revisionrequired

string

Pattern: ^sha256:[a-f0-9]{64}$

versionrequired

integer

Exclusive minimum: 0
Maximum: 9007199254740991

The request contains an invalid parameter, parameter combination, or cursor.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation API key is missing, invalid, expired, or revoked.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation does not have enough credit to reserve this operation.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The authenticated organisation lacks the required scope, or the browser origin is not allowed.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The requested resource does not exist or is not available to this organisation.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The server did not complete the request in time. This failure is non-billable and may be retried.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation request rate was exceeded. Retry after the indicated delay.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The service or durable usage settlement is temporarily unavailable. This failure is non-billable.

This response uses Problem Details.

application/problem+json

Cache-Controlrequired

Public cache policy for the bounded catalogue response.

string

ETagrequired

Strong representation validator for conditional GET requests.

string

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048