user

Get users

Search for a user by its username, name or full email. Name (not username) or email require that the user has enabled this in their settings, unless both users share an external team (synced via OIDC/LDAP), in which case they can always find each other.

get/users

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/users
  • Auth
    API key in header Authorization

Query parameters

sstring

The search criteria.

Response

All (found) users.

bot_owner_idinteger

BotOwnerID is the ID of the owning (human) user if this user is a bot. A non-zero value means this user is a bot and cannot authenticate via password.

createdstring

A timestamp when this task was created. You cannot change this value.

emailstring

The user's email address.

idinteger

The unique, numeric id of this user.

namestring

The full name of the user.

updatedstring

A timestamp when this task was last updated. You cannot change this value.

usernamestring

The username of the user. Is always unique.

Changes

No recorded changes to this operation across all 74 revisions of this API.