Hey.Café Endpoint Docs

Get Cafe

Docs Home / Get Cafe
Public

get_cafe_info

Café info including avatar and header image urls.

Primary URL: https://endpoint.hey.cafe/get_cafe_infoAlias URL: https://endpoint.hey.cafe/api/cafe_info
textRequired
query
The café alias, or id.
Public

get_cafe_conversations

Provides a list of recent conversations made in a café.

Primary URL: https://endpoint.hey.cafe/get_cafe_conversationsAlias URL: https://endpoint.hey.cafe/api/cafe_conversations
textRequired
query
The café alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
text
pinned
Provide the text true if you want to only show pinned conversations.
text
tag
The tag ID to only return conversations with the tag.
text
account
The account ID or alias to limit conversations to.
Public

get_cafe_comments

Provides a list of recent comments made in a café.

Primary URL: https://endpoint.hey.cafe/get_cafe_commentsAlias URL: https://endpoint.hey.cafe/api/cafe_comments
textRequired
query
The café alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
text
pinned
Provide the text true if you want to only show pinned conversations.
Public

get_cafe_members

Get a list of members in a café based on a few specific details if provided, we will show NO members if the café is private and you are not a member.

Primary URL: https://endpoint.hey.cafe/get_cafe_members
textRequired
query
The café alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 50).
text
status
The status of the accounts to find, the options are active, waiting, and banned.
text
account
The ID or alias of the account you want to check for directly.
text
type
The account type. the options are member, admin and moderator.
Requires Token

get_cafe_reports

Fetch a list of the reports made about content in the café.

Primary URL: https://endpoint.hey.cafe/get_cafe_reports
textRequired
query
The café alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
text
status
The status of the report like if it's for discrimination, spam, or more.
boolen
closed
If you want to see closed reports or not using true or false, by default it's false.
text
resource_type
What type of resource, like conversation or comment.
text
resource_id
A resource ID like for the conversation or comment, to prevent overlap you should also supply resource_type.
text
id
Fetch a specific report.