v1

latestOpenAPI 3.1.22026-07-1716233693.2 KB
Index

Get site and API information

Get site and API information.

get/index/

Response

OK

version_idinteger

XenForo version ID

site_titlestring

Title of the site this API relates to

base_urlstring

The base URL of the XenForo install this API relates to

api_urlstring

The base API URL

key[type]string

Type of the API key accessing the API (guest, user or super)

key[user_id]integer nullable

If a user key, the ID of the user the key is for; null otherwise

key[allow_all_scopes]boolean

If true, all scopes can be accessed

key[scopes]string[]

A list of scopes this key can access (if not allowed to access all scopes)