/
/docassemble API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 2h ago · Updated 3w ago
Configuration3
Files3
Interviews10
Packages4
Playground9
Sessions10
System5
Users26
  • postCreate a new user
  • postInvite new user(s)
  • getList users
  • getRetrieve user information by username
  • getGet information about the API owner
  • postSet information about the API owner (POST)
  • patchSet information about the API owner
  • getGet privileges of the API owner
  • getGet information about a user by ID
  • postUpdate user information by ID (POST)
  • deleteMake a user inactive or delete a user account
  • patchUpdate user information by ID
  • getGet privileges of a user by ID
  • postGive a user a privilege
  • deleteRemove a privilege from a user
  • getList available privileges
  • postAdd a privilege
  • deleteDelete a privilege
  • getGet the API owner's API keys
  • postCreate an API key for the API owner
  • deleteDelete an API key of the API owner
  • patchUpdate an API key of the API owner
  • getGet API keys of a user by ID
  • postCreate an API key for a user by ID
  • deleteDelete an API key of a user by ID
  • patchUpdate an API key of a user by ID
    Users

    List users

    Returns a paginated list of registered users. Requires admin, advocate, or the access_user_info permission.

    get/api/user_list

    Query parameters

    include_inactive0 | 1

    Set to 1 to include inactive users.

    next_idstring

    Pagination token from a previous response.

    Response

    Paginated list of users.

    next_idstring nullable required

    Opaque token to pass as next_id to retrieve the next page. null when no further pages exist.

    Changes