Get a Community

This endpoint retrieves community details using the community identifier.

get
Get Community

https://api.whisk.com/community/v2/{community_id}
You can append the following path and query parameters to the base URL to pull details of a particular community:
Request
Response
Request
Path Parameters
community_id
required
string
The community identifier.
Headers
Authentication
required
string
User token to authorize the API usage. For more information, see Authentication.
Query Parameters
fields
optional
array
Any additional community details to retrieve. You can choose one or more of these supported values: - COMMUNITY_FIELD_DESCRIPTION - COMMUNITY_FIELD_TOPICS - COMMUNITY_FIELD_SOCIAL_SETTINGS - COMMUNITY_FIELD_PERMISSIONS - COMMUNITY_FIELD_MEMBERS_COUNT - COMMUNITY_FIELD_RECIPES_COUNT - COMMUNITY_FIELD_SPONSORED Note: For performance reasons, we recommend using this parameter only when required.
Response
200: OK
This is how a successful response looks.
{
"community": {
"id": "string",
"name": "string",
"image": {
"url": "string",
"width": 0,
"height": 0,
"selection": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
},
"description": "string",
"topics": [
{
"id": "string",
"display_name": "string"
}
],
"social_settings": {
"website_url": "string",
"instagram_username": "string",
"youtube_channel_url": "string",
"tiktok_username": "string"
},
"permissions": {
"role": "COMMUNITY_ROLE_INVALID",
"mode": "COMMUNITY_CONTRIBUTION_PERMISSION_MODE_INVALID",
"visibility": "COMMUNITY_VISIBILITY_INVALID"
},
"members": {
"count": 0
},
"recipes": {
"count": 0
},
"is_sponsored": true
}
}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com

Sample Request and Response

Curl Request
Response
Curl Request
curl -X GET "https://api.whisk.com/community/v2/39d539c738eb47debfb1a6319d34235a?fields=COMMUNITY_FIELD_DESCRIPTION&fields=COMMUNITY_FIELD_TOPICS&fields=COMMUNITY_FIELD_SOCIAL_SETTINGS&fields=COMMUNITY_FIELD_PERMISSIONS&fields=COMMUNITY_FIELD_MEMBERS_COUNT&fields=COMMUNITY_FIELD_RECIPES_COUNT&fields=COMMUNITY_FIELD_SPONSORED"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

Response
{
"community": {
"id": "39d539c738eb47debfb1a6319d34235a",
"name": "WAPID Community",
"image": {
"url": "https://whisk-res.cloudinary.com/image/upload/v1611066523/v3/user-recipes/nfaul13bavzqyiirk0sl.jpg",
"width": 1280,
"height": 854
"selection": {
"x": 0,
"y": 88,
"width": 422,
"height": 767
},
"description": "Food and fun with WAPID!",
"topics": [
{
"id": "914d167bb1754adbbcd1f085cdcc4f6c",
"display_name": "Family Friendly"
}
],
"social_settings": {
"website_url": "https://wapid.com/",
"instagram_username": "wapid",
"youtube_channel_url": "https://www.youtube.com/channel/WAPID",
"tiktok_username": "wapid"
},
"permissions": {
"role": "COMMUNITY_ROLE_OWNER",
"mode": "COMMUNITY_CONTRIBUTION_PERMISSION_MODE_ANYONE",
"visibility": "COMMUNITY_VISIBILITY_PUBLIC"
},
"members": {
"count": 1
},
"recipes": {
"count": 2
},
"is_sponsored": true
}
}

Note: To understand the data structure of a community definition, see Community Object.