/users/password-reset/{token}.json

Change password

• token (path, required)

/invites.json

Create an invite

• Api-Key (header, required)
• Api-Username (header, required)

/admin/backups.json

List backups

/admin/backups.json

Create backup

/admin/backups/{filename}

Download backup

• filename (path, required)
• token (query, required)

/admin/backups/{filename}

Send download backup email

• filename (path, required)

/admin/badges.json

List badges

/admin/badges.json

Create badge

/admin/badges/{id}.json

Delete badge

• id (path, required)

/admin/badges/{id}.json

Update badge

• id (path, required)

/admin/groups.json

Create a group

/admin/groups/{id}.json

Delete a group

• id (path, required)

/t/{id}/invite.json

Invite to topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/{id}/notifications.json

Set notification level

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/admin/users/list/{flag}.json

Get a list of users

• flag (path, required)
• order (query)
• asc (query)
• page (query, page)
• show_emails (query)

/admin/users/{id}.json

Delete a user

• id (path, required)

/admin/users/{id}.json

Get a user by id

• id (path, required)

/admin/users/{id}/anonymize.json

Anonymize a user

• id (path, required)

/admin/users/{id}/log_out.json

Log a user out

• id (path, required)

/admin/users/{id}/silence.json

Silence a user

• id (path, required)

/admin/users/{id}/suspend.json

Suspend a user

• id (path, required)

/c/{id}/show.json

Show category

• id (path, required)

/c/{slug}/{id}.json

List topics

• slug (path, required)
• id (path, required)

/categories.json

Retrieves a list of categories

• include_subcategories (query)

/categories.json

Creates a category

/categories/{id}.json

Updates a category

• id (path, required)

/t/{id}/posts.json

Get specific posts from a topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/user_avatar/{username}/refresh_gravatar.json

Refresh gravatar

• username (path, required)

/directory_items.json

Get a public list of users

• period (query, required)
• order (query, required)
• asc (query)
• page (query, page)

/groups.json

List groups

/groups/{id}.json

Get a group

• id (path, required) — Use group name instead of id

/groups/{id}.json

Update a group

• id (path, required)

/groups/{id}/members.json

Remove group members

• id (path, required)

/groups/{id}/members.json

List group members

• id (path, required) — Use group name instead of id

/groups/{id}/members.json

Add group members

• id (path, required)

/latest.json

Get the latest topics

• Api-Key (header, required)
• Api-Username (header, required)
• order (query) — Enum: `default`, `created`, `activity`, `views`, `posts`, `category`, `likes`, `op_likes`, `posters`
• ascending (query) — Defaults to `desc`, add `ascending=true` to sort asc

/notifications.json

Get the notifications that belong to the current user

/notifications/mark-read.json

Mark notifications as read

/post_actions.json

Like a post and other actions

• Api-Key (header, required)
• Api-Username (header, required)

/posts.json

List latest posts across topics

• Api-Key (header, required)
• Api-Username (header, required)
• before (query) — Load posts with an id lower than this value. Useful for pagination.

/posts.json

Creates a new topic, a new post, or a private message

/posts/{id}.json

delete a single post

• id (path, required)

/posts/{id}.json

Retrieve a single post

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/posts/{id}.json

Update a single post

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/posts/{id}/locked.json

Lock a post from being edited

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/posts/{id}/replies.json

List replies to a post

• id (path, required)

/search.json

Search for a term

• q (query) — The query string needs to be url encoded and is made up of the following options: - Search term. This is just a string. Usually it would be the first item in the query. - `@ `: Use the `@` followed by the username to specify posts by this user. - `# `: Use the `#` followed by the category slug to search within this category. - `tags:`: `api,solved` or for posts that have all the specified tags `api+solved`. - `before:`: `yyyy-mm-dd` - `after:`: `yyyy-mm-dd` - `order:`: `latest`, `likes`, `views`, `latest_topic` - `assigned:`: username (without `@`) - `in:`: `title`, `likes`, `personal`, `messages`, `seen`, `unseen`, `posted`, `created`, `watching`, `tracking`, `bookmarks`, `assigned`, `unassigned`, `first`, `pinned`, `wiki` - `with:`: `images` - `status:`: `open`, `closed`, `public`, `archived`, `noreplies`, `single_user`, `solved`, `unsolved` - `group:`: group_name or group_id - `group_messages:`: group_name or group_id - `min_posts:`: 1 - `max_posts:`: 10 - `min_views:`: 1 - `max_views:`: 10 If you are using cURL you can use the `-G` and the `--data-urlencode` flags to encode the query: ``` curl -i -sS -X GET -G "http://localhost:4200/search.json" \ --data-urlencode 'q=wordpress @scossar #fun after:2020-01-01' ```
• page (query, page)

/session/forgot_password.json

Send password reset email

/site.json

Get site info

/t/-/{id}.json

Update a topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/external_id/{external_id}.json

Get topic by external_id

• external_id (path, required)

/t/{id}.json

Remove a topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/{id}.json

Get a single topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/{id}/bookmark.json

Bookmark topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/{id}/change-timestamp.json

Update topic timestamp

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/users.json

Creates a user

• Api-Key (header, required)
• Api-Username (header, required)

/t/{id}/status.json

Update the status of a topic

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/t/{id}/timer.json

Create topic timer

• Api-Key (header, required)
• Api-Username (header, required)
• id (path, required)

/tag/{name}.json

Get a specific tag

• name (path, required)

/tag_groups.json

Get a list of tag groups

/tag_groups.json

Creates a tag group

/tag_groups/{id}.json

Get a single tag group

• id (path, required)

/tag_groups/{id}.json

Update tag group

• id (path, required)

/tags.json

Get a list of tags

/top.json

Get the top topics filtered by period

• Api-Key (header, required)
• Api-Username (header, required)
• period (query) — Enum: `all`, `yearly`, `quarterly`, `monthly`, `weekly`, `daily`

/topics/private-messages-sent/{username}.json

Get a list of private messages sent for a user

• username (path, required)

/topics/private-messages/{username}.json

Get a list of private messages for a user

• username (path, required)

/u/by-external/{external_id}.json

Get a user by external_id

• Api-Key (header, required)
• Api-Username (header, required)
• external_id (path, required)

/u/by-external/{provider}/{external_id}.json

Get a user by identity provider external ID

• Api-Key (header, required)
• Api-Username (header, required)
• provider (path, required) — Authentication provider name. Can be found in the provider callback URL: `/auth/{provider}/callback`
• external_id (path, required)

/u/{username}.json

Get a single user by username

• Api-Key (header, required)
• Api-Username (header, required)
• username (path, required)

/u/{username}.json

Update a user

• Api-Key (header, required)
• Api-Username (header, required)
• username (path, required)

/u/{username}/emails.json

Get email addresses belonging to a user

• username (path, required)

/u/{username}/preferences/avatar/pick.json

Update avatar

• username (path, required)

/u/{username}/preferences/email.json

Update email

• username (path, required)

/u/{username}/preferences/username.json

Update username

• username (path, required)

/uploads.json

Creates an upload

/uploads/abort-multipart.json

Abort multipart upload

/uploads/batch-presign-multipart-parts.json

Generates batches of presigned URLs for multipart parts

/uploads/complete-external-upload.json

Completes a direct external upload

/uploads/complete-multipart.json

Complete multipart upload

/uploads/create-multipart.json

Creates a multipart external upload

/uploads/generate-presigned-put.json

Initiates a direct external upload

/user-badges/{username}.json

List badges for a user

• username (path, required)

/user_actions.json

Get a list of user actions

• offset (query, required, offset)
• username (query, required)
• filter (query, required)