> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Get licenses for organization > Get a list of licenses available for a client organization **Deprecated.** This operation is kept for existing integrations; avoid it in new code. ```http POST https://api2.rhombussystems.com/api/partner/getLicensesForOrg ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `read` scope. - `x-auth-scheme` (header, string, default: `partner-api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`. ## Request body Content type: `application/json`. Request object for getting list of licenses available for a client organization. - `orgUuid` (string | null): base 64 (url-safe) uuid string ## Response 200 OK. Content type: `application/json` - `licenses` (array | null): List of licenses available for the client organization ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/partner/getLicensesForOrg: post: deprecated: true description: Get a list of licenses available for a client organization operationId: getLicensesForOrg parameters: - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters." example: partner-api-token in: header name: x-auth-scheme required: false schema: default: partner-api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/License_GetLicensesForClientOrgWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/License_GetLicensesForClientOrgWSResponse" description: OK "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - read summary: Get licenses for organization tags: - Partner Webservice components: schemas: License_GetLicensesForClientOrgWSRequest: description: Request object for getting list of licenses available for a client organization. properties: orgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object License_GetLicensesForClientOrgWSResponse: description: Response object containing list of licenses available for a client organization. properties: licenses: description: List of licenses available for the client organization items: $ref: "#/components/schemas/LicenseUsageType" nullable: true type: array type: object LicenseUsageType: description: List of licenses available for the client organization properties: addOnLicenseType: $ref: "#/components/schemas/AddOnLicenseEnum" additionalPerceptionFeatures: items: $ref: "#/components/schemas/PerceptionTypeEnum" nullable: true type: array uniqueItems: true claimKeyUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string cloudArchiveDays: format: int32 nullable: true type: integer createdOn: format: date-time nullable: true type: string deviceType: $ref: "#/components/schemas/DeviceTypeEnum" deviceUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string firstAssignedDate: format: date-time nullable: true type: string license: $ref: "#/components/schemas/AddOnLicenseEnum" licenseFamily: $ref: "#/components/schemas/DeviceLicenseFamilyEnum" licenseToUnassignEmailState: $ref: "#/components/schemas/LicenseToUnassignEmailStateEnum" maxDeleteDate: format: date-time nullable: true type: string orgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string ownerOrgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string perceptionTypes: items: $ref: "#/components/schemas/PerceptionTypeEnum" nullable: true type: array uniqueItems: true priorClaimKeyUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string productCode: nullable: true type: string productType: $ref: "#/components/schemas/ProductTypeEnum" state: $ref: "#/components/schemas/LicenseStateEnum" trial: nullable: true type: boolean updatedOn: format: date-time nullable: true type: string uuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object AddOnLicenseEnum: enum: - CLOUD_ARCHIVING - PERCEPTION - POSE - BEHAVIOR - VEHICLE - PEOPLE - PPE - PEOPLE_ANALYTICS - UNKNOWN type: string PerceptionTypeEnum: enum: - PEOPLE_COUNTING - FACE_COUNTING_UNIQUE - FACE_COUNTING_NONUNIQUE - ENGAGMENT_COUNTING - FACE_RECOGNITION - LICENSEPLATE_RECOGNITION - VEHICLE_COUNTING - OCCUPANCY_COUNTING - UNKNOWN type: string DeviceTypeEnum: enum: - BLE_TRACKER - CAMERA - DOOR_SENSOR - ENVIRONMENTAL_SENSOR - OCCUPANCY_SENSOR - AUDIO_GATEWAY - EXECUTABLE - BADGE_READER - DOOR_CONTROLLER - BLE_BUTTON - IO_BOARD - ENVIRONMENTAL_GATEWAY - NVR - ROBOT - UNKNOWN type: string DeviceLicenseFamilyEnum: enum: - CAMERA - CAMERA_MS - VIDEO_INTERCOM - AUDIO_GATEWAY - ENVIRONMENTAL_SENSOR - ENVIRONMENTAL_GATEWAY type: string LicenseToUnassignEmailStateEnum: enum: - INITIAL_EMAIL_SUCCEEDED - INITIAL_EMAIL_FAILED - FIFTEEN_DAY_WARNING_EMAIL_SUCCEEDED - FIFTEEN_DAY_WARNING_EMAIL_FAILED - FOURTY_EIGHT_HOUR_WARNING_EMAIL_SUCCEEDED - FOURTY_EIGHT_HOUR_WARNING_EMAIL_FAILED - UNKNOWN type: string ProductTypeEnum: enum: - DEVICE - ALERT_MONITORING - ACCESS_CONTROL - GUEST_MANAGEMENT - LICENSE_USAGE - PANE - UNKNOWN type: string LicenseStateEnum: enum: - CLAIMED - RENEWED - PENDING_RETURN - NOT_RENEWED - EXPIRED - PERMANENTLY_EXPIRED type: string securitySchemes: ApiKeyAuth: description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````