Retrieve a company · Luranta API

Authorization

Authorization

Bearerrequired

Organisation API key supplied only through the Authorization header. Required scopes: companies:read.

Path parameters

companyId

stringrequired

UUIDv7 identifier of a commercially cleared company.

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})$

Responses

The requested company.

Identity

id

stringrequired

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})$

name

stringrequired

Range:1240

openJobCount

integerrequired

Range:02147483647

type

enumrequired

Available options:companybrandgovernmenteducationhealthcarenonprofitpartnershipagencyother

Location

country

stringrequirednullable

Available options:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW

Industry

industries

enum[]required

Maximum items:20

Available options:agriculture-forestry-fishingmining-natural-resourcesenergy-utilitiesenvironmental-waste-servicesmanufacturingfashion-textiles-apparelconsumer-goodsconstructionreal-estatewholesale-retailtransport-logistics-postalhospitality-food-travelmedia-arts-entertainmenttechnology-information-servicestelecommunicationsfinance-insuranceprofessional-business-serviceseducationhealthcare-life-sciencessocial-caregovernment-public-sectornonprofit-associationspersonal-household-services

Provenance

logoUrl

stringrequirednullable

websiteUrl

stringrequirednullable

Headers

Luranta-Cost-USD

stringoptional

Credit consumed as a USD decimal string. Present only on successful billable responses.

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

Luranta-Credit-Balance-USD

stringoptional

Organisation credit remaining after settlement. Present only on successful billable responses.

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

Luranta-Resources-Returned

integeroptional

Number of resources returned and charged. Present only on successful billable responses.

Range:02147483647

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

Retry-After

integeroptional

Minimum number of seconds before retrying when supplied.

Range:02147483647

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

Retry-After

integeroptional

Minimum number of seconds before retrying when supplied.

Range:02147483647

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

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

This response uses Problem Details.

Identity

title

stringrequired

Range:1120

type

stringrequired

Format:uri

Maximum length:2048

Errors

errors

object[]required

Range:1100

availableCreditUsd

stringoptional

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

code

stringrequired

Range:180

detail

stringrequired

Range:11000

instance

stringrequired

Format:starts_with

Pattern:^\/.*

param

stringoptional

Range:1160

requestId

stringrequired

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})$

requiredCreditUsd

stringoptional

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

retryable

booleanrequired

status

integerrequired

Range:400599

topUpUrl

stringoptional

Format:uri

Maximum length:2048

Headers

Retry-After

integeroptional

Minimum number of seconds before retrying when supplied.

Range:02147483647

traceparent

stringrequired

W3C trace context generated for this request attempt.

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

X-Request-Id

stringrequired

Unique UUIDv7 identifier for this request attempt.

Format:uuid

Authorization

Path parameters

Responses

Identity

Location

Industry

Provenance

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers

Identity

Errors

Child attributes

Headers