Hey.Café Endpoint Docs

Get Account

Docs Home / Get Account
Public

get_account_cafes

Provides a list of cafés a user is in.

Primary URL: https://endpoint.hey.cafe/get_account_cafesAlias URL: https://endpoint.hey.cafe/api/account_cafes
textRequired
query
The account alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
text
cafe
The ID of a specific cafe that must be in, if not in this café it will return no records.
boolean
admin
If TRUE only cafés where user is also admin.
boolean
moderator
If TRUE only cafés where user is moderator.
boolean
manage
If TRUE only cafés where user is admin or moderator.
boolean
favourite
If TRUE only cafés where user has marked as a favourite.
Official APP Only

get_account_checkup

Internal call to update the main app with new items and notifications.

Primary URL: https://endpoint.hey.cafe/get_account_checkupPublic

get_account_conversations

Provides a list of recent conversations.

Primary URL: https://endpoint.hey.cafe/get_account_conversationsAlias URL: https://endpoint.hey.cafe/api/account_conversations
textRequired
query
The account 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.
Public

get_account_comments

Provides a list of recent comments.

Primary URL: https://endpoint.hey.cafe/get_account_commentsAlias URL: https://endpoint.hey.cafe/api/account_comments
textRequired
query
The account 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.
Requires Token

get_account_drafts

Provides a list of recent conversations that are still in draft state for your account.

Primary URL: https://endpoint.hey.cafe/get_account_drafts
number
start
The offset to start at.
number
count
How many items to return (default 20).
Public

get_account_followers

Provides a list of followers a user has.

Primary URL: https://endpoint.hey.cafe/get_account_followers
textRequired
query
The account alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
Public

get_account_following

Provides a list of who a user follows.

Primary URL: https://endpoint.hey.cafe/get_account_following
textRequired
query
The account alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
Public

get_account_friends

Provides a list of people a user follows who follow back.

Primary URL: https://endpoint.hey.cafe/get_account_friends
textRequired
query
The account alias, or id.
number
start
The offset to start at.
number
count
How many items to return (default 20).
Public

get_account_info

Account info including avatar and header image urls.

Primary URL: https://endpoint.hey.cafe/get_account_infoAlias URL: https://endpoint.hey.cafe/api/account_info
textRequired
query
The account alias, or id.
Official APP Only

get_account_locations_countrys

Internal call to list country options for a user to pick from.

Primary URL: https://endpoint.hey.cafe/get_account_locations_countrysOfficial APP Only

get_account_locations_states

Internal call to list state options for a user to pick from once a country is set.

Primary URL: https://endpoint.hey.cafe/get_account_locations_statesPublic

get_account_key

Check if a session, auth or API key is valid, if so it will return data like account_info. This replaces the old loginkey API call.

Primary URL: https://endpoint.hey.cafe/get_account_keyAlias URL: https://endpoint.hey.cafe/api/account_key
textRequired
query
The session or API key.
Requires Token

get_account_blocks

Used to get the blocks of the current account.

Primary URL: https://endpoint.hey.cafe/get_account_blocks
textRequired
type
The type, for now the only option is account.
number
start
The offset to start at.
number
count
How many items to return (default 20).
Requires Token

get_account_notifications

Used to get the most recent 100 notifications of the current account.

Primary URL: https://endpoint.hey.cafe/get_account_notifications
text
query
The id of the notification you want to fetch.
number
start
The offset to start at.
number
count
How many items to return (default 100).
text
seen
If the value is no only new notifications will show, and yes will show already seen.
text
type
The notification type: reply, comment, reply, reaction, comment_reply, mention, account, share, edit.
Requires Token

get_account_referrals

Used to get the referrals of the current account.

Primary URL: https://endpoint.hey.cafe/get_account_referrals
number
start
The offset to start at.
number
count
How many items to return (default 20).
Requires Token

get_account_reports

Used to get the reports made by your account. (This is no longer used or updated)

Primary URL: https://endpoint.hey.cafe/get_account_reports
number
start
The offset to start at.
number
count
How many items to return (default 20).
Requires Token

get_account_rssimport_preview

Used to get a preview for a RSS import feed on the current account.

Primary URL: https://endpoint.hey.cafe/get_account_rssimport_preview
text
query
The ID of the RSS import.
Official APP Only

get_account_secret

Internal call to show the 2FA secret key for setting up a device.

Primary URL: https://endpoint.hey.cafe/get_account_secretOfficial APP Only

get_account_sessions

Internal call to get the sessions of the current account.

Primary URL: https://endpoint.hey.cafe/get_account_sessions