Get Client Profile

Get specific client

post

Retrieve detailed information about a specific client.

Conditional validation rules:

  • If clientId (path parameter) is provided, platformClientId and platform are optional

  • If clientId (path parameter) is empty, both platformClientId and platform are required

Authorizations
AuthorizationstringRequired

Bearer token for API authentication

Path parameters
clientIdstringRequired

The ID of the client to retrieve

Query parameters
botIdstringRequired

The bot ID for the API request

platformClientIdstringOptional

Platform-specific client ID (required if clientId is empty)

platformstring · enumOptional

Platform type (required if clientId is empty)

Possible values:
Body
secretstringRequired

Secret key for API authentication

Example: your_secret_key_here
Responses
200

Client information retrieved successfully

application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Operation completed successfully
post
/openapi/client/{clientId}