Alerts5

Attachments8

Auth3

Conversations15

Featured content1

Forums3

Index1

Me6

Media10

Media albums8

Media categories7

Media comments6

Nodes6

OAuth24

oEmbed1

Posts7

Profile posts11

Resource categories7

Resource reviews6

Resource updates4

Resource versions4

Resources10

Search4

Search forums2

Stats1

Threads12

Users10

Users

Find users by a prefix of their user name

Changed on Mar 18, 2026

Find users by a prefix of their user name.

get/users/find-name

Request

Base URL
https://example.com/api
Auth
- OAuth 2
  Authorization codehttps://example.com/oauth2/authorize
  Token URLhttps://example.com/api/oauth2/token
  Scopesuser:read
- or API key in header XF-Api-Key
TypeScript
https://skmtc.dev/xenforo-ltd/apis/xenforo-api/docs/users/find-name/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

usernamestring required

Response

OK

Changes

Mar 18, 2026b15eba33657a Revision changes
- breaking
  the query request parameter username became required
Mar 18, 2026e271d0e41f6d Revision changes
- info
  api operation id get_users_find_name removed and replaced with getUsersFindName
- info
  the endpoint scheme security XF-Api-Key was added to the API
- info
  the endpoint scheme security XF-OAuth2 was added to the API
- info
  added the new optional header request parameter XF-Api-User to all path's operations
- info
  added the new optional query request parameter api_bypass_permissions to all path's operations

Operation history (3 revisions)