Communities

Search community members

Find members of a community whose handle matches a text.

Reference: https://www.twittrapi.com/docs/reference/communities-communityid-members-search

get/communities/{communityId}/members/search

Request

  • Base URL: https://api.twittrapi.com
  • URL: https://api.twittrapi.com/communities/{communityId}/members/search
  • Auth: API key in header X-API-KEY

Path parameters

communityIdstring required

Numeric community ID, the number in the community URL.

Query parameters

usernamestring required

Text to match, with or without @.

format'raw' | 'simple'

raw (default): X's JSON passed through. simple: flat camelCase JSON with a fixed schema and a {data, nextCursor, previousCursor, hasNextPage} envelope. Same price. The header X-Response-Format: simple does the same.

Response

Raw JSON of X's CommunityMemberRelationshipTypeahead query. Not paginated.

With format=simple: Collection of User objects: {data: [User], nextCursor, previousCursor, hasNextPage}.

OR
RawPassthrough required

X's own JSON (raw format, the default), passed through unchanged. The shape is X's and can change; see https://www.twittrapi.com/docs/response-format.

Changes

No recorded changes to this operation across all 1 revision of this API.