Communities

List the X Communities X suggests to join

Changed on

Returns the communities X suggests, with their full public fields. X picks them per request, so 2 calls can differ. If X suggests none, Xquik asks up to 2 more times. An empty list is free. Each community costs 1 credit.

get/x/communities/suggested

Request

  • Base URL: https://xquik.com/api/v1
  • URL: https://xquik.com/api/v1/x/communities/suggested
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • none

Query parameters

limitinteger

Maximum communities to return. Omit it for every suggestion. A low credit balance can return fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.

fieldsstring
Example:id,text,author.username

Fields to keep in each row, comma-separated. Use dots for nested fields, such as author.username. A list keeps the field in each item. Case & underscores do not matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics always stay. An unknown name answers 400 unknown_field with the valid names, before any read. The price stays the same. SDK row types then hold only the named fields. A longer URL fails at the edge before Xquik reads it.

omitstring
Example:entities,media

Fields to drop from each row, comma-separated. It takes the same names as fields. With fields, it drops from the kept fields. A longer URL fails at the edge before Xquik reads it.

Response

Communities X suggests

countinteger required

Communities returned & charged

messagestring

What to do next. Present only when X suggests none.

Example response

{
  "communities": [
    {
      "id": "1472105760389668865",
      "name": "Tech Twitter",
      "member_count": 121468,
      "is_nsfw": false,
      "primary_topic": {
        "name": "Technology"
      },
      "banner_url": "https://pbs.twimg.com/community_banner_img/example.jpg",
      "membersFacepile": [
        {
          "id": "2864203879",
          "profilePicture": "https://pbs.twimg.com/profile_images/example.jpg"
        }
      ]
    }
  ],
  "count": 1,
  "message": "X suggested no communities. Try again soon."
}

Changes

  • 245194cd4ea7Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status

  • d17988b4a85dRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property const value Ask the user to confirm a payment option before creating checkout. was added for the status

    • info

      removed the Ask the user to confirm a payment option before creating checkout. enum value from the //// response property for the response status

    • info

      removed the Ask the user to top up at /dashboard/account. This key cannot open checkout. enum value from the //// response property for the response status