Get Users

Returns all vendor's users

GET /v3/users

Request

Query Parameters

Name	Type	Description
page	string	Page number to retrieve. Max 1000
limit	string	Limit of users to retrieve, defaults to 10. Max 1000,

Headers

Name	Type	Description
Authorization	string	Authorization token

Response

Samples

200 Result successfully retrieved.

{
  "data": {
    "users": [
      {
        "userId": "1234-asdf-4321-fdsa",
        "firstName": "John",
        "lastName": "Doe",
        "createdAt": "2018-03-19T15:51:27.080Z",
        "transactions": [
          {
            "id": "asdf-1234-fdsa-4321",
            "createdAt": "2018-12-21"
          }
        ],
        "decision": {
          "approved": true,
          "status": "approved",
          "spendingLimit": 1300,
          "availableBalance": 1200,
          "availableWeeklySpending": 120,
          "createdAt": "2018-03-19T15:51:27.080Z"
        },
        "verificationStatus": "succeeded"
      }
    ],
    "meta": {
      "count": 1,
      "totalPages": 1,
      "page": 1,
      "limit": 20
    }
  }
}

Schema

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all users created.

Key	Type	Description
users	Array	The list users.
users.id	Number	Transaction id
users.firstName	String	User's first name
users.lastName	String	Users's last name
users.createdAt	Date	Users creation date
users.decision	Number	Total Shipping Cost
users.decision.approved	Boolean	Determines if the customer was approved or not
users.decision.status	String	Determines the customer application status. Possible values: approved, pending, failed
users.decision.spendingLimit	Number	The spending limit approved
users.decision.availableBalance	Number	Available balance to spend
users.decision.availableWeeklySpending	String	The available amount to spend in a weekly basis
users.decision.createdAt	String	Decision's creation date
users.verificationStatus	String	Verification status the possible status are: pending, failed, succeeded
meta	Object	Pagination Info
meta.count	Number	Total number of users
meta.totalPages	Number	Total number of pages
meta.page	Number	Current page
meta.limit	Number	Current page limit