A client library implementing the full v1 REST API protocol for Mastodon in Guile
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

9.3 KiB

accounts Module


Table of Contents

  1. <mastodon-account>
  2. <mastodon-emoji>
  3. <mastodon-field>
  4. masto-emoji-shortcode
  5. masto-emoji-static-url
  6. masto-emoji-url
  7. masto-emoji-visible-in-picker?
  8. masto-emoji?
  9. masto-field-name
  10. masto-field-value
  11. masto-field-verified-at
  12. masto-field?
  13. masto-account-acct
  14. masto-account-avatar
  15. masto-account-avatar-static
  16. masto-account-bot?
  17. masto-account-created-at
  18. masto-account-discoverable?
  19. masto-account-display-name
  20. masto-account-emojis
  21. masto-account-fields
  22. masto-account-followers-count
  23. masto-account-following-count
  24. masto-account-group?
  25. masto-account-header
  26. masto-account-header-static
  27. masto-account-id
  28. masto-account-last-status-at
  29. masto-account-locked?
  30. masto-account-moved
  31. masto-account-note
  32. masto-account-statuses-count
  33. masto-account-url
  34. masto-account-username
  35. masto-account?
  36. masto-account-create
  37. masto-account-verify-creds
  38. masto-accounts-token


<mastodon-account>

Summary

A record object that can be returned by an API call.

Record Fields

id
username
acct
displayName
locked
bot
discoverable
group
createdAt
followersCount
followingCount
statusesCount
lastStatusAt
note
url
avatar
avatarStatic
header
headerStatic
emojis
moved
fields


<mastodon-emoji>

Summary

A record object that can be returned by an API call.

Record Fields

shortcode
staticURL
url
visibleInPicker


<mastodon-field>

Summary

A record object that can be returned by an API call.

Record Fields

name
value
verifiedAt


masto-emoji-shortcode

Summary

#f

Parameters

#f03c15 s


masto-emoji-static-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-visible-in-picker?

Summary

#f

Parameters

#f03c15 s


masto-emoji?

Summary

#f

Parameters

#f03c15 obj


masto-field-name

Summary

#f

Parameters

#f03c15 s


masto-field-value

Summary

#f

Parameters

#f03c15 s


masto-field-verified-at

Summary

#f

Parameters

#f03c15 s


masto-field?

Summary

#f

Parameters

#f03c15 obj


masto-account-acct

Summary

#f

Parameters

#f03c15 s


masto-account-avatar

Summary

#f

Parameters

#f03c15 s


masto-account-avatar-static

Summary

#f

Parameters

#f03c15 s


masto-account-bot?

Summary

#f

Parameters

#f03c15 s


masto-account-created-at

Summary

#f

Parameters

#f03c15 s


masto-account-discoverable?

Summary

#f

Parameters

#f03c15 s


masto-account-display-name

Summary

#f

Parameters

#f03c15 s


masto-account-emojis

Summary

#f

Parameters

#f03c15 s


masto-account-fields

Summary

#f

Parameters

#f03c15 s


masto-account-followers-count

Summary

#f

Parameters

#f03c15 s


masto-account-following-count

Summary

#f

Parameters

#f03c15 s


masto-account-group?

Summary

#f

Parameters

#f03c15 s


masto-account-header

Summary

#f

Parameters

#f03c15 s


masto-account-header-static

Summary

#f

Parameters

#f03c15 s


masto-account-id

Summary

#f

Parameters

#f03c15 s


masto-account-last-status-at

Summary

#f

Parameters

#f03c15 s


masto-account-locked?

Summary

#f

Parameters

#f03c15 s


masto-account-moved

Summary

#f

Parameters

#f03c15 s


masto-account-note

Summary

#f

Parameters

#f03c15 s


masto-account-statuses-count

Summary

#f

Parameters

#f03c15 s


masto-account-url

Summary

#f

Parameters

#f03c15 s


masto-account-username

Summary

#f

Parameters

#f03c15 s


masto-account?

Summary

#f

Parameters

#f03c15 obj


masto-account-create

Summary

Creates a user and account records.

The app should save this token for later and should wait for the user to confirm their account by clicking a link in their E-mail inbox.

agreement is whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE.

reason is text that will be reviewed by moderators, if registrations require manual approval.

An account access token for the app that initiated the request is returned.

Find the original documentation within this page.

Parameters

#f03c15 mastoApp
#f03c15 username
#f03c15 email
#f03c15 password
#f03c15 agreement
#f03c15 locale
#c5f015 [reason]


masto-account-verify-creds

Summary

Test to make sure that the user token works for the user tied to mastoApp.

A <mastodon-account> of the user, with source, is returned.

Find the original documentation within this page.

Parameters

#f03c15 mastoApp


masto-accounts-token

Summary

#f

Parameters

#f03c15 mastoApp
#f03c15 eMail
#f03c15 username
#f03c15 password
#f03c15 locale