Query Customers

get

https://api.swervepay.com/v/2.0/{accountSid}/customers

This is a resource for querying customers. The response will include a customerList of individual customer records.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountSid

string

required

length between 0 and 256

Account SID in my account

Query Params

accountRefId

string

length between 0 and 256

The Account Number from the calling system

afterId

string

length between 0 and 12

Include results with customerId greater than this value

beforeId

string

length between 0 and 12

Include results with customerId less than this value

count

string

length between 0 and 4

The number of results to return (default 10, max 1000)

customerEmail

string

length between 0 and 255

customerFirstName

string

length between 0 and 255

First Name

customerId

string

length between 0 and 12

Customer unique identifier

customerLastName

string

length between 0 and 255

Last Name

customerPhoneNumber

string

length between 0 and 14

Mobile Number

customerRefId

string

length between 0 and 256

Customer Reference Id from the calling system

maxId

string

length between 0 and 12

Include results with transactionId less than or equal to this value

minId

string

length between 0 and 12

Include results with transactionId greater or equal to this value

name

string

length between 0 and 255

First and/or last name

sort

string

length between 0 and 18

Response list sort order

Valid Values:

transactionId_asc, transactionId_desc

transactionId_asc: Sort by transactionId in ascending order

transactionId_desc: (Default) Sort by transactionId in descendingorder

systemCustomerRefId

string

length between 0 and 256

Transaction Source

Valid Values: auth, capture, credit, refund, sale, validate, void, return

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unvailable

504

Gateway Timeout

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request