---
title: "Users"
slug: "users-7"
updated: 2025-08-26T17:54:08Z
published: 2025-08-26T18:38:53Z
canonical: "guide.youraspire.com/users-7"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.youraspire.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Users

## **Description**

Information associated with a user.

## Resource Overview

| **Endpoint** | **Definition** |
| --- | --- |
| [](https://guide.youraspire.com/preview/v1-api/en/65e608a6-a5c6-45e2-bf09-9cfd1a9dae67/1)[GET/Users](https://guide.youraspire.com/apidocs/users-4) | Retrieve a list of users and associated information. |
| [POST/Users](https://guide.youraspire.com/apidocs/users-5) | Add a user. |
| [PUT/Users](https://guide.youraspire.com/apidocs/users-6) | Modify existing users. |

## Attributes

| Attribute | Description | **Data Type** | Notes |
| --- | --- | --- | --- |
| UserID | unique identifier for the user | integer |  |
| AllBranchAccess | indicates if the user has access to all branches | boolean |  |
| BranchAccess | list of the user's associated branch access | list of integer, string |  |
| ExternalContactReference | name of the external contact's reference. | string |  |
| ContactFirstName | first name of user contact | string |  |
| ContactLastName | last name of user contact | string |  |
| Active | indicates if the user is active | boolean |  |
| UserRoles | list of the user's role names and unique identifier of the roles | list of integer, string |  |