{
  "opencollection": "1.0.0",
  "info": {
    "name": "YOOBIC Public Answers Communities API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Communities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://<base_url>/public/api/communities/:id",
            "headers": [
              {
                "name": "Accept",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "668d495b335f79001d10cfd7",
                "type": "path",
                "description": "The id of the community"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a community for the given id."
        },
        {
          "info": {
            "name": "Get all communitites",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://<base_url>/public/api/communities?filter=:filter",
            "headers": [
              {
                "name": "Accept",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "filter",
                "value": "{\"where\": {\"audience_id\": \"668d22072e701b001dec95bb\"}}",
                "type": "query",
                "description": "A valid JSON filter object"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get all communities."
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://<base_url>/public/api/communities",
            "headers": [
              {
                "name": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/",
              "accessTokenUrl": "/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a community"
        },
        {
          "info": {
            "name": "Nominate a community manager",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://<base_url>/public/api/communities/:community_id/promote_manager/:manager_id",
            "params": [
              {
                "name": "community_id",
                "value": "668d495b335f79001d10cfd7",
                "type": "path",
                "description": "The id of the community"
              },
              {
                "name": "manager_id",
                "value": "662a4534fb6cd214b1fab989",
                "type": "path",
                "description": "The id of the manager"
              }
            ]
          },
          "docs": "Nominate the manager of a community"
        },
        {
          "info": {
            "name": "Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://<base_url>/public/api/communities/count?where=:where",
            "headers": [
              {
                "name": "Accept",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "where",
                "value": "{ \"property\": \"value\" }",
                "type": "query",
                "description": "A valid JSON [Where filter](#section-api-requests-filter-where)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Count all the existing entities based on the where filter"
        },
        {
          "info": {
            "name": "Export",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://<base_url>/public/api/communities/export?type=:type&filter=:filter",
            "headers": [
              {
                "name": "Accept",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "type",
                "value": "csv",
                "type": "path",
                "description": "The type of file, either `csv` (default value) or `excel`"
              },
              {
                "name": "filter",
                "value": "{}",
                "type": "query",
                "description": "A valid JSON filter object (does not accept a `fields` filter)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Export all results as a file.    \nThis action is asynchronous and returns the id of a job. See [`jobs`](#group-jobs) endpoint to query the status of the job. The file will contain the results with all of the fields specified on the resource."
        }
      ]
    }
  ],
  "bundled": true
}