v1

latestOpenAPI 3.0.12026-07-26101626.2 KB
Registered Clients

Get Registered client

Get information about the Registered client of specified identifier.

get/admin/api/v1/SubClient/{id}

Path parameters

idstring uuid required

The identifier of the Registered client

Response

Get registered client

status'ok' | 'serverFailure' | 'permissionDenied' | 'badRequest' | 'notFound' | 'conflict' | 'tooManyRequest' | 'locked' | 'unavailableForLegalReasons'
messagestring nullable

A message generated by the API

displayMessagestring nullable

User-friendly display message that can be presented to the end user

errorHashstring nullable

An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping

teamCodestring nullable

Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS. Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.

errorTypestring nullable

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

{"stackTrail":"components:schemas:B2B2BRegisteredClientDataApiResult:properties:errorData","oasType":"schema","type":"unknown","nullable":true}