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

# Users

> Users connect their payroll accounts using Link.

## Definition

"User" is the Argyle term for someone who connects their payroll accounts through Link.

<Frame>
  <img src="https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/users/users.png?fit=max&auto=format&n=lpddaw6ggr_B1oHD&q=85&s=0bd624920a137c63dddfdd3b9c5f88b3" alt="What users are in Argyle terminology." width="2700" height="1044" data-path="images/argyle-guides/overview/users/users.png" />
</Frame>

<Note>
  In most contexts "user" is interchangeable with borrower, loan applicant, or employee.
</Note>

## Connecting new users

There are three ways to direct users to Link, where they can connect their payroll accounts:

1. [Embed Link](/link/initialization) and route new users through your website or application.
2. Invite new users via text or email, using either Console's [send invites](/console/flows/email-sms-templates#sending-invites) feature or the API's [`/invites`](/api-reference/invites) endpoint.
3. Share a [direct URL](/console/flows/shareable-urls) to Argyle's payroll connection experience.

## Returning users

Argyle makes it easy to allow users to return to Link in order to:

* Connect additional payroll accounts
* Re-authorize an existing connection
* Revoke access at any time to a connected account

For more information, visit our dedicated [Reconnecting Accounts](/workflows/reconnecting-accounts) guide.

## Viewing users

<div className="argyle-divider" />

### Console

Navigate to the [Connections](https://console.argyle.com/connections) section of Console. From there, you can filter all users or select individual users to display Argyle's [data sets](/overview/data-structure/data-sets) and generate [reports](/overview/data-structure/reports).

<Frame>
  <img src="https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/3-how-argyle-works.png?fit=max&auto=format&n=zs6lb-w1jQV9DVbr&q=85&s=1106b7f4f15e8975df2090e84a497cd2" alt="Console is an online and no-code way to retrieve payroll data using Argyle." width="2100" height="1350" data-path="images/overview/how-argyle-works/3-how-argyle-works.png" />
</Frame>

### API

There are two API endpoints related to users:

* [`/users`](/api-reference/users) — retrieve information for a single user, or a list of users.
* [`/invites`](/api-reference/invites) — send invites or retrieve information on sent invites.

### External identifiers

External identifiers such as `Loan Applicant #319` can be attached to users.

You can search or filter users by their external identifier [via the API](/api-reference/users#list) or within the main [Connections table](https://console.argyle.com/connections) of Console, where external identifiers will also appear next to the name of individual users.

<Frame>
  <img src="https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/users/2-users.png?fit=max&auto=format&n=lpddaw6ggr_B1oHD&q=85&s=b54562bf37927b04af1ded32491e95b2" alt="External identifiers can be used to categorize and search through users." width="2100" height="1350" data-path="images/argyle-guides/overview/users/2-users.png" />
</Frame>

How to add external identifiers to users:

#### Console:

* New users — use the *optional* `External id` input field when [sending invites](/console/flows/email-sms-templates#sending-invites).
  <Note>
    You can toggle `External id` to be a *required* invite field within [Console settings](https://console.argyle.com/settings/other-settings).
  </Note>

* Existing users — select an individual user within the [Connections](https://console.argyle.com/connections) section of Console, click on the three vertical dots in the upper-right, and select `Add external ID`.

#### API:

* New users — when [creating a new user](/api-reference/users#create).
* Existing users — when [updating an existing user](/api-reference/users#update).
