Get community info

1 credit per call · All plans from $0.00012/credit

curl https://xquik.com/api/v1/x/communities/1234567890/info \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq

Use GET /x/communities/{id}/info when a workflow needs one durable community profile row before member exports, moderator review, content routing, or CRM enrichment. Store community_id, community_name, description, member_count, moderator_count, join_policy, banner_url, created_at, primary_topic_name, and rule_count.

Path parameters

string

required

Community ID (numeric string).

Headers

x-api-key

string

required

Your API key. Session cookie authentication is also supported.

Response

community

object

Community details.

Show community object

string

Community ID.

name

string

Community name. Omitted if unavailable.

description

string

Community description. Omitted if empty.

member_count

number

Total member count. Omitted if unavailable.

moderator_count

number

Moderator count. Omitted if unavailable.

join_policy

string

Join policy (e.g. Open). Omitted if unavailable.

banner_url

string

Banner image URL. Omitted if unavailable.

created_at

string

ISO 8601 creation timestamp. Omitted if unavailable.

primary_topic

object

Primary topic with id and name fields. Omitted if unavailable.

rules

object[]

Community rules, each with id, name, and description. Omitted if unavailable.

{
  "community": {
    "id": "1234567890",
    "name": "Web Developers",
    "description": "A community for web developers",
    "member_count": 15000,
    "moderator_count": 5,
    "join_policy": "Open",
    "created_at": "2024-01-15T00:00:00.000Z",
    "primary_topic": { "id": "1", "name": "Technology" },
    "rules": [
      { "id": "1", "name": "Be respectful", "description": "Treat all members with respect." }
    ]
  }
}

{ "error": "invalid_community_id" }

The community ID is empty or invalid.

{ "error": "unauthenticated" }

Missing or invalid API key.

{ "error": "no_subscription" }

No active subscription or insufficient credits. Possible error values: no_subscription, subscription_inactive, no_credits, insufficient_credits. For MPP requests without a valid payment credential, 402 returns a WWW-Authenticate: Payment challenge header instead.

{ "error": "not_found" }

The community could not be resolved. Check the community ID.

{ "error": "x_api_unavailable" }

The read service returned an error. Retry after a short delay.

{ "error": "rate_limit_exceeded", "retryAfter": 60 }

Your tier rate limit was exceeded. Wait for the Retry-After header before retrying.

{ "error": "x_api_unavailable" }

The normalized v1 response contract can return 424 when the read service is unavailable.

Next steps: Community Members to list members, or Community Tweets to browse posts.

Documentation Index

​Path parameters

​Headers

​Response

Path parameters

Headers

Response