v16

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-04-0886158866.0 KB
Client Management

List Clients

Get a list of clients on a service.

If the access token can view a full service (including an admin), all clients within the service are returned. Otherwise, only clients that the access token can view within the service are returned.

  • ViewClient: []
get/api/{serviceId}/client/get/list

Path parameters

serviceIdstring required

A service ID.

Query parameters

developerstring

The developer of client applications. The default value is null. If this parameter is not set to null, client application of the specified developer are returned. Otherwise, all client applications that belong to the service are returned.

startinteger

Start index (inclusive) of the result set. The default value is 0. Must not be a negative number.

endinteger

End index (exclusive) of the result set. The default value is 5. Must not be a negative number.

Response

startinteger

Start index (inclusive) of the result set of the query.

endinteger

End index (exclusive) of the result set of the query.

totalCountinteger

Total number of clients that belong to the service. This doesn't mean the number of clients contained in the response.

Example response

{
  "clients": [
    {
      "number": 1140735077,
      "serviceNumber": 715948317,
      "clientName": "My Test Client",
      "clientId": "1140735077",
      "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ",
      "clientType": "PUBLIC",
      "redirectUris": [
        "https://example.com/callback"
      ],
      "responseTypes": [
        "CODE"
      ],
      "grantTypes": [
        "AUTHORIZATION_CODE"
      ]
    }
  ]
}