| Requires any of the roles: | admin, oauthadmin, member, oauthmember |
| GET | /Ams/{ClientID}/CBXClientConfig | Retrieve client CBX configuration information for use client-side. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CBXClientId | form | string | No | |
| CBXIntegrationId | form | string | No | |
| CBXProductId | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/CBXClientConfig HTTP/1.1
Host: ws.yourmembership.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"CBXClientId":"String","CBXIntegrationId":"String","CBXProductId":"String","UsingRedis":true,"AppInitTime":"2025-04-26T11:56:36.3376632-04:00","ServerID":"WS-6-131-057","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-04-26T13:37:42.0933164-04:00","Device":"Desktop"}