FlexShopper API
3.0-legacy
FlexShopper API
3.0-legacy
  • Getting Started
  • Our Platforms
    • FlexPay Payment Platform
    • FlexShopper Backend API
  • API Reference
    • Get Started
      • API Requests
      • API Responses
      • Error Codes
    • User Management
      • Create User
      • Get Users
      • Get User
      • Verify User Exists
      • Deeply Verify User Exists
      • Get LoanPaymentPro Child Key
      • Add Payment Method
    • Customer Authentication
      • Request Passcode
      • Login Customer
    • Customer Application
      • Initiate Application
      • Get Verification Questions
      • Verify Answers
      • Validate Routing Number
    • Lease Management
      • Create Lease
      • Get Lease By ID
      • Sign Lease
      • Checkout
    • Purchase Transactions
      • Get Transactions
      • Get Transaction By ID
      • Cancel Items
      • Return Items
      • Confirm Shipment
      • Confirm Receipt
    • Products
      • Get Products
    • Settings
  • Change Log
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. User Management

Get Users

Returns all vendor's users

GET https://apis.sandbox.flexshopper.com/v3/users

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

{
  "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
    }
  }
}

Response Parameters

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

PreviousCreate UserNextGet User

Last updated 10 months ago

Was this helpful?