Hey.Café Endpoint Docs

Get Staff

Docs Home / Get Staff
Requires Token

get_staff_account

For internal staff use only. Gets info on a account.

Primary URL: https://endpoint.hey.cafe/get_staff_account
textRequired
query
The ID or Alias of the account to lookup.
Requires Token

get_staff_cafe

For internal staff use only. Gets info on a café.

Primary URL: https://endpoint.hey.cafe/get_staff_cafe
textRequired
query
The ID or Alias of the café to lookup.
Requires Token

get_staff_conversation

For internal staff use only. Gets info on a conversation.

Primary URL: https://endpoint.hey.cafe/get_staff_conversation
textRequired
query
The ID of the conversation to lookup.
ERROR

get_staff_conversation_comments

For internal staff use only. Gets comments on a conversation.

Primary URL: https://endpoint.hey.cafe/get_staff_conversation_commentsAlias URL: https://endpoint.hey.cafe/api/conversation_comments
textRequired
query
The conversation ID
number
start
The offset to start at.
number
count
How many items to return (default 20).
boolean
pinned
Provide the text true if you want to only show pinned conversations.
text
comment
Get comments that are only a child to this comment (a reply).
text
account
Get comments that are only made by this account.
Requires Token

get_staff_comment

For internal staff use only. Gets info on a comment.

Primary URL: https://endpoint.hey.cafe/get_staff_comment
textRequired
query
The ID of the comment to lookup.
Requires Token

get_staff_account_sessions

For internal staff use only. Gets most recent sessions from a account.

Primary URL: https://endpoint.hey.cafe/get_staff_account_sessions
textRequired
query
The ID or Alias of the account.
Requires Token

get_staff_account_events

For internal staff use only. Gets most recent events from a account.

Primary URL: https://endpoint.hey.cafe/get_staff_account_events
textRequired
query
The ID or Alias of the account.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_chat_info

For internal staff use only. Get info on a chat like last message dates, who is in the chat room and more

Primary URL: https://endpoint.hey.cafe/get_staff_chat_info
textRequired
query
The ID for the chat room
Requires Token

get_staff_chat_list

For internal staff use only. Gets a list of chat rooms an account is in.

Primary URL: https://endpoint.hey.cafe/get_staff_chat_list
textRequired
query
The ID or Alias of the account.
number
start
The offset to start at.
number
count
How many items to return (default 20).
Requires Token

get_staff_chat_messages

For internal staff use only. Gets a list of messages in an account chat room, this is restricted to the highest level admins and requires an active account report to open.

Primary URL: https://endpoint.hey.cafe/get_staff_chat_messages
textRequired
query
The ID or Alias of the account.
textRequired
chat
The ID for the chat room.
number
start
The offset to start at.
number
count
How many items to return (default 20).
text
message
If provided ONLY this message will be returned.
Requires Token

get_staff_account_conversations

For internal staff use only. Gets most recent conversations from a account.

Primary URL: https://endpoint.hey.cafe/get_staff_account_conversations
textRequired
query
The ID or Alias of the account.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_cafe_conversations

For internal staff use only. Gets most recent conversations from a café.

Primary URL: https://endpoint.hey.cafe/get_staff_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.
Requires Token

get_staff_cafe_members

For internal staff use only. Get a list of members in a café based on a few specific details if provided.

Primary URL: https://endpoint.hey.cafe/get_staff_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_staff_account_comments

For internal staff use only. Gets most recent comments from a account.

Primary URL: https://endpoint.hey.cafe/get_staff_account_comments
textRequired
query
The ID or Alias of the account.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_search_accounts

For internal staff use only. Searches the system for accounts based on a query.

Primary URL: https://endpoint.hey.cafe/get_staff_search_accounts
base64Required
search
The search query.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_search_sessions

For internal staff use only. Searches the system for accounts based on session via a query.

Primary URL: https://endpoint.hey.cafe/get_staff_search_sessions
base64Required
search
The search query.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_search_cafes

For internal staff use only. Searches the system for cafés based on a query.

Primary URL: https://endpoint.hey.cafe/get_staff_search_cafes
base64Required
search
The search query.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_search_comments

For internal staff use only. Searches the system for comments based on a query.

Primary URL: https://endpoint.hey.cafe/get_staff_search_comments
base64Required
search
The search query.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_search_conversations

For internal staff use only. Searches the system for conversations based on a query.

Primary URL: https://endpoint.hey.cafe/get_staff_search_conversations
base64Required
search
The search query.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.
Requires Token

get_staff_reports

For internal staff use only. Fetches all content reports.

Primary URL: https://endpoint.hey.cafe/get_staff_reports
text
id
Fetch info on a specific report.
text
status
The status type like spam, impersonation, discrimination, abuse, other.
text
closed
If set to true only will return closed items, otherwise only open items will show.
text
resource_type
The resource type like account, cafe, conversation, or comment.
text
resource_id
The resource id.
text
search_raw
You can use this if you want to provide the text without encoding.
number
count
Number of items to show.
number
start
Offset for results.