BusinessMode
Sign inGet started

Get an entitlement

Entitlements · getEntitlement

GET/projects/{projectId}/entitlements/{entitlementId}

Base URL: https://api.businessmode.io/v1

Authentication

Developer bearer token

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

NameInRequiredType and constraints
projectIdpathYesstringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
entitlementIdpathYesstringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Request body

No request body is defined.

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

200 Successful response.

Content type: application/json

object · EntitlementResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
createdAtstringYesFormat: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
descriptionanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
string
  • Maximum length: 2000
Alternative 2
null
idstringYesFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
keystringYesPattern: ^[a-z0-9][a-z0-9._:-]*$ · Minimum length: 1 · Maximum length: 128
namestringYesMinimum length: 1 · Maximum length: 200
updatedAtstringYesFormat: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

400 Invalid request.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

401 Authentication failed.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

404 The authorized resource was not found.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

500 An unexpected server error occurred.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

Understand the Entitlements concept →

← All API operations