Check effective entitlement access
Seats · hasAccess
GET
/accessBase URL: https://api.businessmode.io/v1
Authentication
Machine API key
The requirement above comes from this operation's OpenAPI security declaration. See Authentication.
Parameters
| Name | In | Required | Type and constraints |
|---|---|---|---|
externalUserId | query | Yes | stringMinimum length: 1 · Maximum length: 512 |
entitlementKey | query | Yes | stringPattern: ^[a-z0-9][a-z0-9._:-]*$ · Minimum length: 1 · Maximum length: 128 |
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 · HasAccessResponse
- No additional properties
| Field | Type | Required | Description / constraints |
|---|---|---|---|
hasAccess | boolean | Yes |
400 Invalid request.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
401 Authentication failed.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
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
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
500 An unexpected server error occurred.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|