# Get Users

<mark style="color:blue;">`GET`</mark> /v3/users

## Request

The details below help you form your HTTP requests to this endpoint.

### Headers

You may need to provide specific headers.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>x-consumer-custom-id</td><td>string</td><td>true</td><td>Consumer data with the format "channel:vendorId"</td></tr></tbody></table>

### Query

You may provide query parameters to filter the output.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>page</td><td>number</td><td>false</td><td>Page number to retrieve. Max 1000</td></tr><tr><td>limit</td><td>number</td><td>false</td><td>Limit of users to retrieve. Max 1000</td></tr></tbody></table>

## Response

The details below help you understand the responses you could get from this endpoint.

### Samples

Below are samples of responses, with tabs corresponding to returned status code.

{% tabs %}
{% tab title="200" %}

```javascript
{
    "data": {
        "users": [
            {
                "userId": "1234-asdf-4321-fdsa",
                "firstName": "John",
                "lastName": "Doe",
                "email": "Doe",
                "createdAt": "2018-03-19T15:51:27.080Z",
                "transactions": [
                    {
                        "id": "asdf-1234-fdsa-4321",
                        "createdAt": "2018-12-21",
                        "lease": {
                            "id": "eyJhbGcfasdvczOiJIUzI1NiIsInR5cCI6IkpXVC...",
                            "status": "signed"
                        }
                    }
                ],
                "decision": {
                    "applicationId": "d363955e-3110-11e8-a373-5e7783c1a76e",
                    "prequalId": "5a319511a86980001d602095",
                    "approved": true,
                    "status": "approved",
                    "spendingLimit": 1300,
                    "availableBalance": 1200,
                    "availableWeeklySpending": 120,
                    "createdAt": "2018-03-19T15:51:27.080Z",
                    "waterfallSuppressionFlags": {
                        "suppressWaterfallToUOwn": false
                    },
                    "vantageHighScore": true,
                    "funnel": "tireagent"
                },
                "verificationStatus": "succeeded"
            }
        ],
        "meta": {
            "count": 1,
            "totalPages": 1,
            "page": 1,
            "limit": 20
        }
    }
}
```

{% endtab %}

{% tab title="400" %}

```javascript
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}
```

{% endtab %}
{% endtabs %}

### Schema

The response's schema is outlined below.

<table><thead><tr><th>Name</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.users</td><td>array</td><td>true</td><td>N/A</td></tr><tr><td>data.users[].userId</td><td>string</td><td>true</td><td>User Id</td></tr><tr><td>data.users[].firstName</td><td>string</td><td>true</td><td>User's first name</td></tr><tr><td>data.users[].lastName</td><td>string</td><td>true</td><td>User's last name</td></tr><tr><td>data.users[].email</td><td>string</td><td>true</td><td>User's last name</td></tr><tr><td>data.users[].createdAt</td><td>string</td><td>true</td><td>User's creation date</td></tr><tr><td>data.users[].transactions</td><td>array</td><td>false</td><td>N/A</td></tr><tr><td>data.users[].transactions[].id</td><td>string</td><td>true</td><td>Transaction Id</td></tr><tr><td>data.users[].transactions[].createdAt</td><td>string</td><td>true</td><td>Transaction's creation date</td></tr><tr><td>data.users[].transactions[].lease</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.users[].transactions[].lease.id</td><td>string</td><td>true</td><td>lease identifier</td></tr><tr><td>data.users[].transactions[].lease.status</td><td>string</td><td>true</td><td>N/A</td></tr><tr><td>data.users[].decision</td><td>object</td><td>true</td><td>N/A</td></tr><tr><td>data.users[].decision.applicationId</td><td>string</td><td>true</td><td>Application Id</td></tr><tr><td>data.users[].decision.prequalId</td><td>string</td><td>false</td><td>prequalification ID</td></tr><tr><td>data.users[].decision.approved</td><td>boolean</td><td>true</td><td>Determines if the customer was approved or not(To be deprecated)</td></tr><tr><td>data.users[].decision.status</td><td>string</td><td>true</td><td>Determines the customer application status. Possible values: approved, pending, failed</td></tr><tr><td>data.users[].decision.spendingLimit</td><td>number</td><td>true</td><td>The spending limit approved</td></tr><tr><td>data.users[].decision.availableBalance</td><td>number</td><td>false</td><td>Available balance to spend</td></tr><tr><td>data.users[].decision.availableWeeklySpending</td><td>number</td><td>false</td><td>The available amount to spend in a weekly basis</td></tr><tr><td>data.users[].decision.createdAt</td><td>string</td><td>true</td><td>Decision's creation date</td></tr><tr><td>data.users[].decision.waterfallSuppressionFlags</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.users[].decision.waterfallSuppressionFlags.suppressWaterfallToUOwn</td><td>boolean</td><td>false</td><td>Determines if uown needs to be skipped)</td></tr><tr><td>data.users[].decision.vantageHighScore</td><td>boolean</td><td>false</td><td>N/A</td></tr><tr><td>data.users[].decision.funnel</td><td>string</td><td>false</td><td>N/A</td></tr><tr><td>data.users[].verificationStatus</td><td>string</td><td>true</td><td>Verification status the possible status are: pending, failed, succeeded</td></tr><tr><td>data.meta</td><td>object</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.count</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.totalPages</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.page</td><td>number</td><td>false</td><td>N/A</td></tr><tr><td>data.meta.limit</td><td>number</td><td>false</td><td>N/A</td></tr></tbody></table>