XenForo REST API Endpoints

https://xenforo.com/community/pages/api-endpoints
Admin
Documentation for the XenForo REST API, detailing available endpoints, data types, and methods for...
Tokens:28,736
Snippets:109
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### GET /stats/

Source: https://xenforo.com/community/pages/api-endpoints/index

Gets site statistics and general activity information.

```APIDOC
## GET /stats/

### Description
Gets site statistics and general activity information.

### Method
GET

### Endpoint
/stats/

### Parameters
None.

### Response
#### Success Response (200)
- **totals[threads]** (integer) - Total number of threads.
- **totals[messages]** (integer) - Total number of messages.
- **totals[users]** (integer) - Total number of registered users.
- **latest_user[user_id]** (integer) - ID of the latest registered user.
- **latest_user[username]** (string) - Username of the latest registered user.
- **latest_user[register_date]** (integer) - Registration date of the latest user (Unix timestamp).
- **online[total]** (integer) - Total number of users currently online.
- **online[members]** (integer) - Number of registered users currently online.
- **online[guests]** (integer) - Number of guests currently online.

#### Response Example
```json
{
  "totals": {
    "threads": 15000,
    "messages": 100000,
    "users": 5000
  },
  "latest_user": {
    "user_id": 5001,
    "username": "NewUser",
    "register_date": 1678890000
  },
  "online": {
    "total": 250,
    "members": 200,
    "guests": 50
  }
}
```
```

--------------------------------

### GET /threads/

Source: https://xenforo.com/community/pages/api-endpoints/index

Gets a list of threads with various filtering and ordering options.

```APIDOC
## GET /threads/

### Description
Gets a list of threads with various filtering and ordering options.

### Method
GET

### Endpoint
/threads/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number of threads to retrieve.
- **prefix_id** (integer) - Optional - Filters to only threads with the specified prefix.
- **starter_id** (integer) - Optional - Filters to only threads started by the specified user ID.
- **last_days** (integer) - Optional - Filters to threads that have had a reply in the last X days.
- **unread** (bool) - Optional - Filters to unread threads only (ignored for guests).
- **thread_type** (string) - Optional - Filters to threads of the specified thread type.
- **order** (string) - Optional - Method of ordering: `last_post_date`, `post_date`. Within a forum context: `title`, `reply_count`, `view_count`, `vote_score`, `first_post_reaction_score`.
- **direction** (string) - Optional - Either `asc` or `desc` for ascending or descending order (applies only if `order` is provided).

### Response
#### Success Response (200)
- **threads** (Thread[]) - An array of thread objects.
- **pagination** (pagination) - Pagination information for the threads.

#### Response Example
```json
{
  "threads": [
    {
      "thread_id": 201,
      "title": "Discussion on API",
      "post_date": 1678886400,
      "reply_count": 15,
      "view_count": 100
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 8,
    "per_page": 30
  }
}
```
```

--------------------------------

### Index API

Source: https://xenforo.com/community/pages/api-endpoints/index

Provides general information about the XenForo installation.

```APIDOC
## GET index/

### Description
Retrieves general information about the XenForo installation, such as version and site name.

### Method
GET

### Endpoint
/index/

### Response
#### Success Response (200)
- **site_title** (string) - The title of the website.
- **version** (string) - The XenForo version.

#### Response Example
```json
{
  "site_title": "XenForo Community",
  "version": "2.2.10"
}
```
```

--------------------------------

### Stats API

Source: https://xenforo.com/community/pages/api-endpoints/index

Provides statistical information about the XenForo installation.

```APIDOC
## GET stats/

### Description
Retrieves various statistics about the XenForo installation, such as user count and thread count.

### Method
GET

### Endpoint
/stats/

### Response
#### Success Response (200)
- **user_count** (integer) - Total number of registered users.
- **thread_count** (integer) - Total number of threads.
- **post_count** (integer) - Total number of posts.

#### Response Example
```json
{
  "user_count": 5000,
  "thread_count": 100000,
  "post_count": 1000000
}
```
```

--------------------------------

### GET /users/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a list of users, sorted alphabetically, with pagination support.

```APIDOC
## GET users/

### Description
Gets a list of users (alphabetically).

### Method
GET

### Endpoint
/users/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number of users to retrieve.

### Response
#### Success Response (200)
- **users** (User[]) - A list of user objects.
- **pagination** (pagination) - Pagination details.
```

--------------------------------

### GET /search-forums/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Gets information about a specified search forum, optionally including threads.

```APIDOC
## GET /search-forums/{id}/

### Description
Gets information about the specified search forum.

### Method
GET

### Endpoint
/search-forums/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the search forum.

#### Query Parameters
- **with_threads** (bool) - Optional - If true, retrieves a page of threads in this search forum.
- **page** (integer) - Optional - The page number of threads to retrieve.

### Response
#### Success Response (200)
- **search_forum** (SearchForum) - Information about the search forum.
- **threads** (Thread[]) - Threads on the current page (if `with_threads` is true).
- **pagination** (pagination) - Pagination information for the threads.
- **sticky** (Thread[]) - Sticky threads on page 1.

#### Response Example
```json
{
  "search_forum": {
    "search_forum_id": 1,
    "title": "General Discussion"
  },
  "threads": [
    {
      "thread_id": 101,
      "title": "First Post",
      "post_date": 1678886400
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "per_page": 20
  },
  "sticky": [
    {
      "thread_id": 99,
      "title": "Important Announcement",
      "post_date": 1678000000
    }
  ]
}
```
```

--------------------------------

### GET /nodes/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves the entire node tree structure of the XenForo site.

```APIDOC
## GET /nodes/

### Description
Gets the node tree.

### Method
GET

### Endpoint
/nodes/

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
(No request body needed for this GET request)

### Response
#### Success Response (200)
(The response structure for the node tree is not detailed in the provided text, but would typically be a nested JSON object representing the hierarchy of nodes.)

#### Response Example
```json
{
  "nodes": [
    {
      "node_id": 1,
      "title": "General Discussion",
      "node_type_id": "Forum",
      "children": [
        {
          "node_id": 2,
          "title": "Off-Topic",
          "node_type_id": "Forum"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /me/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about the currently authenticated API user.

```APIDOC
## GET /me/

### Description
Gets information about the current API user.

### Method
GET

### Endpoint
/me/

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
(No request body needed for this GET request)

### Response
#### Success Response (200)
- **me** (User) - An object containing the current user's information.

#### Response Example
```json
{
  "me": {
    "user_id": 123,
    "username": "ExampleUser",
    "avatar_url": "https://xenforo.com/avatars/123.1678886400/default.jpg"
  }
}
```
```

--------------------------------

### GET /index/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves general information about the XenForo site and the API, including version, URLs, and API key details.

```APIDOC
## GET /index/

### Description
Gets general information about the site and the API.

### Method
GET

### Endpoint
/index/

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Request Example
(No request body needed for this GET request)

### Response
#### Success Response (200)
- **version_id** (integer) - The XenForo version ID.
- **site_title** (string) - The title of the site this API relates to.
- **base_url** (string) - The base URL of the XenForo install this API relates to.
- **api_url** (string) - The base API URL.
- **key[type]** (string) - Type of the API key accessing the API (guest, user or super).
- **key[user_id]** (integer|null) - 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).

#### Response Example
```json
{
  "version_id": 2020000,
  "site_title": "XenForo Community",
  "base_url": "https://xenforo.com",
  "api_url": "https://xenforo.com/api",
  "key": {
    "type": "user",
    "user_id": 123,
    "allow_all_scopes": false,
    "scopes": ["read", "write"]
  }
}
```
```

--------------------------------

### Search API

Source: https://xenforo.com/community/pages/api-endpoints/index

Endpoints for performing searches within the XenForo installation.

```APIDOC
## POST search/

### Description
Initiates a new search query.

### Method
POST

### Endpoint
/search/

### Request Body
- **search_query** (string) - Required - The text to search for.
- **content_types** (array) - Optional - An array of content types to search within (e.g., ['post', 'thread']).
- **user_id** (integer) - Optional - Filter results by a specific user.

### Response
#### Success Response (201)
- **search_id** (integer) - The ID of the initiated search.
- **result_url** (string) - The URL to view the search results.

#### Response Example
```json
{
  "search_id": 4001,
  "result_url": "/search/4001/"
}
```
```

--------------------------------

### GET /search-forums/{id}/threads

Source: https://xenforo.com/community/pages/api-endpoints/index

Gets a page of threads from the specified search forum.

```APIDOC
## GET /search-forums/{id}/threads

### Description
Gets a page of threads from the specified search forum.

### Method
GET

### Endpoint
/search-forums/{id}/threads

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the search forum.

#### Query Parameters
- **page** (integer) - Optional - The page number of threads to retrieve.

### Response
#### Success Response (200)
- **threads** (Thread[]) - Threads on the current page.
- **pagination** (pagination) - Pagination information for the threads.
- **sticky** (Thread[]) - Sticky threads on page 1.

#### Response Example
```json
{
  "threads": [
    {
      "thread_id": 101,
      "title": "Example Thread Title",
      "post_date": 1678886400
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 3,
    "per_page": 25
  },
  "sticky": [
    {
      "thread_id": 50,
      "title": "Pinned Topic",
      "post_date": 1678000000
    }
  ]
}
```
```

--------------------------------

### GET /conversations/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a list of conversations for the API user.

```APIDOC
## GET /conversations/

### Description
Gets the API user's list of conversations.

### Method
GET

### Endpoint
/conversations/

### Parameters
*No parameters are required for this endpoint.*

### Response
#### Success Response (200)
*The response structure for this endpoint is not detailed in the provided text. Typically, it would return an array of conversation objects.*
```

--------------------------------

### GET /users/find-name

Source: https://xenforo.com/community/pages/api-endpoints/index

Finds users by a prefix of their username. Returns an exact match and a list of recommendations.

```APIDOC
## GET /users/find-name

### Description
Finds users by a prefix of their user name.

### Method
GET

### Endpoint
/users/find-name

### Parameters
#### Query Parameters
- **username** (string) - Required - The username prefix to search for.

### Response
#### Success Response (200)
- **exact** (User|null) - The user that exactly matched the given username, or null if no exact match.
- **recommendations** (User[]) - A list of users whose usernames start with the provided prefix.

#### Response Example
```json
{
  "exact": {
    "user_id": 1,
    "username": "testuser"
  },
  "recommendations": [
    {
      "user_id": 2,
      "username": "testuser_1"
    },
    {
      "user_id": 3,
      "username": "testuser_abc"
    }
  ]
}
```
```

--------------------------------

### GET /forums/{id}

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific forum, optionally including threads.

```APIDOC
## GET /forums/{id}

### Description
Retrieves information about a specific forum, optionally including threads.

### Method
GET

### Endpoint
/forums/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the forum to retrieve.

#### Query Parameters
- **with_threads** (bool) - Optional - If true, retrieves a page of threads within this forum.
- **page** (integer) - Optional - The page number of threads to retrieve if `with_threads` is true.
- **prefix_id** (integer) - Optional - Filters to threads with the specified prefix ID.
- **starter_id** (integer) - Optional - Filters to threads started by the specified user ID.
- **last_days** (integer) - Optional - Filters to threads that have had a reply in the last X days.
- **unread** (bool) - Optional - Filters to unread threads only. Ignored for guests.
- **thread_type** (string) - Optional - Filters to threads of the specified thread type.
- **order** (string) - Optional - Method of ordering: `last_post_date`, `post_date`. When in a specific forum context: `title`, `reply_count`, `view_count`, `vote_score`, `first_post_reaction_score`.
- **direction** (string) - Optional - Either "asc" or "desc" for ascending or descending order. Applies only if an `order` is provided.
```

--------------------------------

### GET /profile-posts/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific profile post, optionally including its comments.

```APIDOC
## GET /profile-posts/{id}/

### Description
Gets information about the specified profile post.

### Method
GET

### Endpoint
/profile-posts/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the profile post to retrieve.
#### Query Parameters
- **with_comments** (boolean) - Optional - If specified, the response will include a page of comments.
- **page** (integer) - Optional - The page of comments to include.
- **direction** (string) - Optional - Request a particular sort order for comments - default 'desc' (newest first) also allows 'asc' (oldest first).

### Response
#### Success Response (200)
- **profile_post** (ProfilePost) - The profile post object.
- **comments** (ProfilePostComment[]) - List of comments on the requested page (if `with_comments` is true).
- **pagination** (pagination) - Pagination details for comments (if `with_comments` is true).

#### Response Example
```json
{
  "profile_post": {
    "profile_post_id": 101,
    "user_id": 789,
    "message": "This is a profile post.",
    "post_date": 1678886400
  },
  "comments": [
    {
      "comment_id": 123,
      "profile_post_id": 101,
      "user_id": 100,
      "message": "Great post!",
      "post_date": 1678886500
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}
```
```

--------------------------------

### GET /profile-post-comments/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific profile post comment.

```APIDOC
## GET /profile-post-comments/{id}/

### Description
Gets information about the specified profile post comment.

### Method
GET

### Endpoint
/profile-post-comments/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the profile post comment to retrieve.

### Response
#### Success Response (200)
- **comment** (ProfilePostComment) - The profile post comment object.

#### Response Example
```json
{
  "comment": {
    "comment_id": 123,
    "profile_post_id": 456,
    "user_id": 789,
    "message": "This is a comment.",
    "post_date": 1678886400
  }
}
```
```

--------------------------------

### GET /media-categories/{id}/content

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a page of content (albums or media) from a specified media category.

```APIDOC
## GET /media-categories/{id}/content

### Description
Gets a page of content from the specified category. This can return albums if it's an album category, or media if it's a media category.

### Method
GET

### Endpoint
`/media-categories/{id}/content`

### Parameters
#### Query Parameters
None.

### Response
#### Success Response (200)
- **albums** (XFMG_Album[]) - If an album category, albums on this page.
- **media** (XFMG_Media[]) - If a media category, media on this page.
- **pagination** (pagination) - Pagination information.

#### Response Example
```json
{
  "albums": [
    {
      "album_id": 1,
      "title": "Sample Album",
      "description": "This is a sample album."
    }
  ],
  "media": [],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "page_count": 1,
    "total_results": 1
  }
}
```
```

--------------------------------

### GET /alerts/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific alert using its ID.

```APIDOC
## GET /alerts/{id}/

### Description
Retrieves information about a specific alert using its ID.

### Method
GET

### Endpoint
/alerts/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the alert to retrieve.

### Response
#### Success Response (200)
- **alert** (UserAlert) - Information about the specified alert.

#### Response Example
```json
{
  "alert": {
    "alert_id": 123,
    "user_id": 456,
    "alert_text": "Some alert text.",
    "alert_date": 1678886400,
    "read": false,
    "link_url": "/some/link",
    "link_title": "Click Here"
  }
}
```
```

--------------------------------

### GET /users/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves detailed information about a specific user, with an option to include their recent profile posts.

```APIDOC
## GET /users/{id}/

### Description
Gets information about the specified user.

### Method
GET

### Endpoint
/users/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the user to retrieve.

#### Query Parameters
- **with_posts** (bool) - Optional - If true, includes a page of profile posts in the response.
- **page** (integer) - Optional - Specifies the page number of profile posts to retrieve when `with_posts` is true.

### Response
#### Success Response (200)
- **user** (User) - The user object.
- **profile_posts** (ProfilePost[]) - A list of profile posts for the requested page (only if `with_posts` is true).
- **pagination** (pagination) - Pagination details for the profile posts (only if `with_posts` is true).

#### Response Example
```json
{
  "user": {
    "user_id": 1,
    "username": "example_user"
  },
  "profile_posts": [
    {
      "post_id": 101,
      "message": "Hello there!"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}
```
```

--------------------------------

### GET /users/{id}/profile-posts

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a paginated list of profile posts for a specific user's profile.

```APIDOC
## GET /users/{id}/profile-posts

### Description
Gets a page of profile posts on the specified user's profile.

### Method
GET

### Endpoint
/users/{id}/profile-posts

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.

### Response
#### Success Response (200)
- **profile_posts** (ProfilePost[]) - List of profile posts on the requested page.
- **pagination** (pagination) - Pagination details.
```

--------------------------------

### GET /attachments/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves attachments associated with a given API attachment key. Only returns attachments that have not yet been associated with content.

```APIDOC
## GET /attachments/

### Description
Retrieves attachments associated with a given API attachment key. Only returns attachments that have not yet been associated with content.

### Method
GET

### Endpoint
/attachments/

### Parameters
#### Query Parameters
- **key** (string) - Required - The API attachment key.

### Response
#### Success Response (200)
- **attachments** (Attachment[]) - A list of matching attachments.

#### Response Example
```json
{
  "attachments": [
    {
      "attachment_id": 1,
      "filename": "example.jpg",
      "content_type": "image/jpeg",
      "size": 102400
    }
  ]
}
```
```

--------------------------------

### GET /forums/{id}/threads

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a paginated list of threads from a specified forum, with options to filter by prefix, starter, recent replies, unread status, and thread type.

```APIDOC
## GET /forums/{id}/threads

### Description
Gets a page of threads from the specified forum.

### Method
GET

### Endpoint
/forums/{id}/threads

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the forum to retrieve threads from.

#### Query Parameters
- **page** (integer) - Optional - The page number of threads to retrieve.
- **prefix_id** (integer) - Optional - Filters to only threads with the specified prefix.
- **starter_id** (integer) - Optional - Filters to only threads started by the specified user ID.
- **last_days** (integer) - Optional - Filters to threads that have had a reply in the last X days.
- **unread** (boolean) - Optional - Filters to unread threads only. Ignored for guests.
- **thread_type** (string) - Optional - Filters to threads of the specified thread type.
- **order** (string) - Optional - Method of ordering: `last_post_date`, `post_date`. When in a specific forum context: `title`, `reply_count`, `view_count`, `vote_score`, `first_post_reaction_score`.
- **direction** (string) - Optional - Either "asc" or "desc" for ascending or descending. Applies only if an order is provided.

### Request Example
```json
{
  "page": 1,
  "order": "last_post_date",
  "direction": "desc"
}
```

### Response
#### Success Response (200)
- **threads** (Thread[]) - An array of threads on the current page.
- **pagination** (pagination) - Pagination information for the thread list.
- **sticky** (Thread[]) - If on page 1, a list of sticky threads in this forum. Does not count towards the per page limit.

#### Response Example
```json
{
  "threads": [
    {
      "thread_id": 1,
      "title": "Example Thread",
      "post_date": 1678886400,
      "reply_count": 5
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10
  },
  "sticky": []
}
```
```

--------------------------------

### GET /profile-posts/{id}/comments

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a paginated list of comments for a specific profile post.

```APIDOC
## GET /profile-posts/{id}/comments

### Description
Gets a page of comments on the specified profile post.

### Method
GET

### Endpoint
/profile-posts/{id}/comments

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the profile post to retrieve comments for.
#### Query Parameters
- **page** (integer) - Optional - The page of comments to retrieve.
- **direction** (string) - Optional - Request a particular sort order for comments - default 'desc' (newest first) also allows 'asc' (oldest first).

### Response
#### Success Response (200)
- **comments** (ProfilePostComment[]) - List of comments on the requested page.
- **pagination** (pagination) - Pagination details.

#### Response Example
```json
{
  "comments": [
    {
      "comment_id": 123,
      "profile_post_id": 101,
      "user_id": 100,
      "message": "Great post!",
      "post_date": 1678886500
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}
```
```

--------------------------------

### GET /threads/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves detailed information about a specific thread, with options to include posts, the first post, and the last post.

```APIDOC
## GET threads/{id}/

### Description
Gets information about the specified thread.

### Method
GET

### Endpoint
/threads/{id}/

### Parameters
#### Query Parameters
- **with_posts** (bool) - Optional - If specified, the response will include a page of posts.
- **page** (integer) - Optional - The page of posts to include.
- **with_first_post** (bool) - Optional - If specified, the response will contain the first post in the thread.
- **with_last_post** (bool) - Optional - If specified, the response will contain the last post in the thread.
- **order** (string) - Optional - Request a particular sort order for posts from the available options for the thread type.

### Response
#### Success Response (200)
- **thread** (Thread) - Description of the thread.
- **first_unread** (Post) - If the thread is unread, information about the first unread post.
- **first_post** (Post) - If requested, information about the first post in the thread.
- **last_post** (Post) - If requested, information about the last post in the thread.
- **pinned_post** (Post) - The pinned first post of the thread, if specified by the thread type.
- **highlighted_posts** (Post[]) - A list of highlighted posts, if relevant to the thread type. The reason for highlighting depends on thread type.
- **posts** (Post[]) - List of posts on the requested page. Note that even if the first post is pinned, it will be included here.
- **pagination** (pagination) - Pagination details.
```

--------------------------------

### POST /users/

Source: https://xenforo.com/community/pages/api-endpoints/index

Creates a new user account within the XenForo system.

```APIDOC
## POST users/

### Description
Creates a user.

### Method
POST

### Endpoint
/users/

### Parameters
#### Request Body
[Details for user creation parameters would go here, e.g., username, email, password, etc.]

### Response
#### Success Response (200)
[Details for successful user creation response would go here, e.g., user object, success message.]
```

--------------------------------

### POST /search/

Source: https://xenforo.com/community/pages/api-endpoints/index

Initiates a new search. The specific parameters and functionality depend on the search implementation.

```APIDOC
## POST /search/

### Description
Creates a new search. This endpoint is a placeholder and its specific functionality depends on the search implementation.

### Method
POST

### Endpoint
/search/

### Parameters
*Note: Specific parameters for this endpoint are not detailed in the provided text. Please refer to the search implementation documentation.* 

### Response
*Note: The response structure for this endpoint is not detailed in the provided text.*
```

--------------------------------

### GET /attachments/{id}/retina-thumbnail

Source: https://xenforo.com/community/pages/api-endpoints/index

Gets the URL to an attachment's thumbnail, if one exists. The URL is returned via a 301 redirect.

```APIDOC
## GET /attachments/{id}/retina-thumbnail

### Description
Gets the URL to an attachment's thumbnail, if one exists. The URL is returned via a 301 redirect.

### Method
GET

### Endpoint
/attachments/{id}/retina-thumbnail

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the attachment for which to get the thumbnail URL.

### Response
#### Success Response (200)
- **url** (string) - The URL to the thumbnail is returned via a 301 redirect's Location header.

#### Response Example
(A 301 redirect response with a Location header pointing to the thumbnail URL)

#### Errors
- **not_found**: Returned if the attachment does not have a thumbnail.
```

--------------------------------

### POST /threads/

Source: https://xenforo.com/community/pages/api-endpoints/index

Creates a new thread, with options for discussion type, prefixes, tags, and attachments.

```APIDOC
## POST /threads/

### Description
Creates a thread. Thread type data can be set using additional input specific to the target thread type.

### Method
POST

### Endpoint
/threads/

### Parameters
#### Request Body
- **node_id** (integer) - Required - The ID of the forum to create the thread in.
- **title** (string) - Required - The title of the thread.
- **message** (string) - Required - The body of the first post in the thread.
- **discussion_type** (string) - Optional - The type of thread to create. Specific types may require additional input.
- **prefix_id** (integer) - Optional - ID of the prefix to apply to the thread.
- **tags** (string[]) - Optional - Array of tag names to apply to the thread.
- **custom_fields[<name>]** (string) - Optional - Value to apply to a custom field.
- **discussion_open** (bool) - Optional - Whether the discussion should be open.
- **sticky** (bool) - Optional - Whether the thread should be sticky.
- **attachment_key** (string) - Optional - API attachment key for uploading files.

### Request Example
```json
{
  "node_id": 10,
  "title": "New Feature Request",
  "message": "I would like to request a new feature for the API.",
  "discussion_type": "thread",
  "tags": ["api", "feature"],
  "attachment_key": "abc123xyz"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **thread** (Thread) - The newly created thread object.

#### Errors
- **no_permission** - No permission error.

#### Response Example
```json
{
  "success": true,
  "thread": {
    "thread_id": 301,
    "title": "New Feature Request",
    "post_date": 1678891000,
    "user_id": 123,
    "username": "ExampleUser"
  }
}
```
```

--------------------------------

### GET /conversation-messages/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a specific conversation message by its ID.

```APIDOC
## GET /conversation-messages/{id}/

### Description
Gets the specified conversation message.

### Method
GET

### Endpoint
/conversation-messages/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the conversation message to retrieve.

### Response
#### Success Response (200)
- **message** (ConversationMessage) - The conversation message object.
```

--------------------------------

### POST /profile-posts/

Source: https://xenforo.com/community/pages/api-endpoints/index

Creates a new profile post on a user's profile.

```APIDOC
## POST /profile-posts/

### Description
Creates a new profile post.

### Method
POST

### Endpoint
/profile-posts/

### Parameters
#### Request Body
- **user_id** (integer) - Required - The ID of the user whose profile this will be posted on.
- **message** (string) - Required - The content of the profile post.
- **attachment_key** (string) - Optional - API attachment key to upload files. Attachment key context type must be profile_post with context[profile_user_id] set to this user ID.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **profile_post** (ProfilePost) - The created profile post object.

#### Response Example
```json
{
  "success": true,
  "profile_post": {
    "profile_post_id": 101,
    "user_id": 789,
    "message": "This is a new profile post.",
    "post_date": 1678886400
  }
}
```
```

--------------------------------

### POST /auth/login-token

Source: https://xenforo.com/community/pages/api-endpoints/index

Generates a token that allows automatic login to a specific XenForo user when a login URL is visited. This feature is for super user keys only and has options for IP limiting, return URLs, and forced logins.

```APIDOC
## POST /auth/login-token

### Description
Generates a token that can automatically log into a specific XenForo user when the login URL is visited. If the visitor is already logged into a XenForo account, they will not be logged into the specified account. Only available to super user keys.

### Method
POST

### Endpoint
/auth/login-token

### Parameters
#### Request Body
- **user_id** (integer) - Required - The ID of the user to log in.
- **limit_ip** (string) - Optional - If provided, locks the token to the specified IP for additional security.
- **return_url** (string) - Optional - If provided, after logging the user will be returned to this URL. Otherwise they'll go to the XenForo index.
- **force** (boolean) - Optional - If provided, the login URL will forcibly replace the currently logged in user if a user is already logged in and different to the currently logged in user. Defaults to false.
- **remember** (boolean) - Optional - Controls whether the a "remember me" cookie will be set when the user logs in. Defaults to true.

### Response
#### Success Response (200)
- **login_token** (string) - The generated login token.
- **login_url** (string) - Direct user to this URL to trigger a login.
- **expiry_date** (integer) - Unix timestamp of when the token expires. An error will be displayed if the token is expired or invalid.
```

--------------------------------

### POST /attachments/

Source: https://xenforo.com/community/pages/api-endpoints/index

Uploads an attachment. An API attachment key must be created first. This endpoint must be submitted using multipart/form-data encoding.

```APIDOC
## POST /attachments/

### Description
Uploads an attachment. An API attachment key must be created first. This endpoint must be submitted using multipart/form-data encoding.

### Method
POST

### Endpoint
/attachments/

### Parameters
#### Request Body (multipart/form-data)
- **key** (string) - Required - The API attachment key to be associated with.
- **attachment** (file) - Required - The attachment file.

### Response
#### Success Response (200)
- **attachment** (Attachment) - The attachment record of the successful upload.

#### Response Example
```json
{
  "attachment": {
    "attachment_id": 2,
    "filename": "uploaded.png",
    "content_type": "image/png",
    "size": 51200
  }
}
```

#### Errors
- **attachment_key_user_wrong**: Triggered if the user making the request does not match the user that created the attachment key.
```

--------------------------------

### GET /conversations/{id}/messages

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves a page of messages from a specified conversation.

```APIDOC
## GET /conversations/{id}/messages

### Description
Retrieves a page of messages from a specified conversation.

### Method
GET

### Endpoint
/conversations/{id}/messages

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the conversation to retrieve messages from.

#### Query Parameters
- **page** (integer) - Optional - The page number of messages to retrieve.

### Response
#### Success Response (200)
- **messages** (ConversationMessage[]) - A list of message objects.
- **pagination** (pagination) - Pagination details for the messages.
```

--------------------------------

### POST /me/

Source: https://xenforo.com/community/pages/api-endpoints/index

Updates information about the current API user, including options, profile details, privacy settings, and visibility.

```APIDOC
## POST /me/

### Description
Updates information about the current user.

### Method
POST

### Endpoint
/me/

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
- **option[creation_watch_state]** (string) - Watch state for new content.
- **option[interaction_watch_state]** (string) - Watch state for interactions.
- **option[content_show_signature]** (boolean) - Whether to show the user's signature in content.
- **option[email_on_conversation]** (boolean) - Whether to receive email notifications for conversations.
- **option[push_on_conversation]** (boolean) - Whether to receive push notifications for conversations.
- **option[receive_admin_email]** (boolean) - Whether to receive administrative emails.
- **option[show_dob_year]** (boolean) - Whether to show the year of birth.
- **option[show_dob_date]** (boolean) - Whether to show the date of birth.
- **profile[location]** (string) - The user's location.
- **profile[website]** (string) - The user's website URL.
- **profile[about]** (string) - A short description about the user.
- **profile[signature]** (string) - The user's signature.
- **privacy[allow_view_profile]** (string) - Privacy setting for profile viewing.
- **privacy[allow_post_profile]** (string) - Privacy setting for profile posting.
- **privacy[allow_receive_news_feed]** (string) - Privacy setting for receiving news feed.
- **privacy[allow_send_personal_conversation]** (string) - Privacy setting for sending personal conversations.
- **privacy[allow_view_identities]** (string) - Privacy setting for viewing identities.
- **visible** (boolean) - Whether the user is visible.
- **activity_visible** (boolean) - Whether the user's activity is visible.
- **timezone** (string) - The user's timezone.
- **custom_title** (string) - The user's custom title.
- **custom_fields[<name>]** (string) - A key-value pair for custom user fields.

### Request Example
```json
{
  "profile": {
    "location": "New York"
  },
  "timezone": "America/New_York"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### GET /attachments/{id}/

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific attachment using its ID.

```APIDOC
## GET /attachments/{id}/

### Description
Retrieves information about a specific attachment using its ID.

### Method
GET

### Endpoint
/attachments/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the attachment to retrieve.

### Response
#### Success Response (200)
- **attachment** (Attachment) - Information about the specified attachment.

#### Response Example
```json
{
  "attachment": {
    "attachment_id": 4,
    "filename": "document.docx",
    "content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "size": 512000
  }
}
```
```

--------------------------------

### GET /conversations/{id}

Source: https://xenforo.com/community/pages/api-endpoints/index

Retrieves information about a specific conversation, optionally including messages.

```APIDOC
## GET /conversations/{id}

### Description
Retrieves information about a specific conversation, optionally including messages.

### Method
GET

### Endpoint
/conversations/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the conversation to retrieve.

#### Query Parameters
- **with_messages** (bool) - Optional - If specified, the response will include a page of messages.
- **page** (integer) - Optional - The page of messages to include if `with_messages` is true.

### Response
#### Success Response (200)
- **conversation** (Conversation) - The conversation object.
- **messages** (ConversationMessage[]) - Optional - A list of messages on the requested page, if `with_messages` is true.
- **pagination** (pagination) - Optional - Pagination details for the messages, if `with_messages` is true.
```
Tokens:
Raw