{"info":{"_postman_id":"7c15836f-b7de-4802-87b2-080cb17bbe15","name":"Community Graphs Public API","description":"

Welcome

Hello builder! Welcome to the documentation for building with Community Graphs. We are excited you are here to build with us! Community Graphs is in an early stage of development and is expanding in functionality quickly! Please let us know if there are any features you would like that can aid you in creating your vision with Community Graphs.

On with the documentation.

Obtaining an API Key

Contact Leo, Jesse, or Cait (who probably linked this document to you) to obtain your key, if you do not have one already. Each API key gives access to one or more communities, so be sure to specify the communit(y, ies) you need to access.

API Endpoints

The base URL for all endpoints is: https://api.communitygraphs.xyz/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome","slug":"welcome"},{"content":"Obtaining an API Key","slug":"obtaining-an-api-key"},{"content":"API Endpoints","slug":"api-endpoints"}],"owner":"3131837","collectionId":"7c15836f-b7de-4802-87b2-080cb17bbe15","publishedId":"2sA3kd9cTA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-31T18:07:48.000Z"},"item":[{"name":"Get Community","id":"c76c8aa6-4b27-40e2-848c-8a2b41e8781b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"testAccessKey","type":"text"}],"url":"https://api.communitygraphs.xyz/external/getCommunity?community_id=c7bd0f32-a31f-41d7-9a87-f5a7ab738e83","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	string	Unique ID of the community
name	string	Name of the community.
avatar_url	string \| null	URL to the community's avatar image
avatar_thumbnail_url	string \| null	URL to the thumbnail image of the community's avatar
tg_link	string \| null	Telegram or Element link for the community
description	string \| null	Description of the community and its purpose
member_count	integer	Number of members in the community.
handle	string	Handle of the community.
privacy_level	string	Privacy level of the community (1 = low, 2 = med, 3 = high, 4 = max).
is_permissionless	boolean	If true, community does not require approval to join.
gating_mechanism	string \| null	Gating mechanism for the community
gated_by	string \| null	ID of the gating entity
is_top_level	boolean	Is community a top level community
is_event_gated	boolean	Is community gated by event attendance

","urlObject":{"path":["external","getCommunity"],"host":["https://api.communitygraphs.xyz"],"query":[{"key":"community_id","value":"c7bd0f32-a31f-41d7-9a87-f5a7ab738e83"}],"variable":[]}},"response":[],"_postman_id":"c76c8aa6-4b27-40e2-848c-8a2b41e8781b"},{"name":"Get Community Members","id":"b132f248-d80c-44ae-808a-5d57ba2b3552","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"testAccessKey","type":"text"}],"url":"https://api.communitygraphs.xyz/external/getMembers?community_id=c7bd0f32-a31f-41d7-9a87-f5a7ab738e83","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
name	string	Full name of the member.
handle	string	Handle of the member.
id	string	Unique ID of member.
avatar_url	string \| null	URL to the member’s avatar image
avatar_thumbnail_url	string \| null	URL to the thumbnail image of the member’s avatar
role	integer	Member’s role in the community (1 = admin, 2 = moderator, 3 = member)
membership_level	number	A value of 0 to 1 representing the member’s membership level within the community. (Higher levels indicate a user is more integrated into the community.)

","urlObject":{"path":["external","getMembers"],"host":["https://api.communitygraphs.xyz"],"query":[{"key":"community_id","value":"c7bd0f32-a31f-41d7-9a87-f5a7ab738e83"}],"variable":[]}},"response":[],"_postman_id":"b132f248-d80c-44ae-808a-5d57ba2b3552"}],"event":[{"listen":"prerequest","script":{"id":"0b96d572-9f7f-41b7-88dd-fd3f3991d5ed","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"af285a15-6ed1-43dc-bce4-3f88ba3e93eb","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.communitygraphs.xyz","type":"string"}]}