Get a Community

This endpoint retrieves community details using the community identifier.

Get Community

GET 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:

Path Parameters

Query Parameters

Headers

{
  "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
  }
}

Sample Request and Response

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.

Last updated