FlexShopper API
3.0
FlexShopper API
3.0
  • Introduction
  • Integration Guides
    • Medusa
    • Payment Plugin
  • Customer
    • Verify User Exists
    • Deeply Verify User Exists
    • Create User
    • Get Users
    • Get User
    • Create Authorization Token
    • Add Payment Method
      • Get LoanPaymentPro Child Key
      • Get Clover PKMS Key
  • Decision
    • Apply for Spending Limit
  • Lease
    • Create Lease
    • Get Transactions
    • Get Lease By ID
    • Get Transaction By ID
    • Sign Lease
    • Finalize Lease
    • Cancel Items
    • Return Items
    • Confirm Shipment
    • Confirm Receipt
Powered by GitBook
On this page
  • Request
  • Headers
  • Query
  • Response
  • Samples
  • Schema

Was this helpful?

Export as PDF
  1. Customer

Get Users

Get all users for a given vendor

GET /v3/users

Request

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

Headers

You may need to provide specific headers.

Name
Type
Required
Description

x-consumer-custom-id

string

Consumer data with the format "channel:vendorId"

Query

You may provide query parameters to filter the output.

Name
Type
Required
Description

page

number

Page number to retrieve. Max 1000

limit

number

Limit of users to retrieve. Max 1000

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.

{
    "data": {
        "meta": {
            "count": 1,
            "totalPages": 1,
            "page": 1,
            "limit": 20
        }
    }
}
{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email ex@example.com",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name
Type
Required
Description

data.users

array

N/A

data.meta.count

number

N/A

data.meta.totalPages

number

N/A

data.meta.page

number

N/A

data.meta.limit

number

N/A

PreviousCreate UserNextGet User

Last updated 4 days ago

Was this helpful?