<back to all web services
GetClubsListRequest
The following routes are available for this service:| GET | /v2/{ApiKey}/corp/{ChainId}/clubs | Get Clubs | Get a list of all clubs by ChainID |
|---|
| GET | /corp/{chainId}/clubs | Get Clubs | Get a list of all clubs by ChainID |
|---|
GetClubsListRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| ChainId | query | integer | Yes | Corporate Chain ID. |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
ApiDtoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No | |
RestrictedResourceType Enum:| Store | |
| Chain | |
| User | |
| Undefined | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
GET /v2/{ApiKey}/corp/{ChainId}/clubs HTTP/1.1
Host: clubready.com
Accept: text/csv