Search for Customers

get https://{environment}.{server}.com/v3/customer/search

Get a collection of customers matching the supplied criteria. At least one parameter is required.

Specify the search in the URL query string.

Example: GET [base_url]customer/search?name=John will get all customers in your database that start with John. All searches are case insensitive. If you have a custom field set for a customer, those fields are searchable by keys as well.

Responses

Response body

object

messages

object

notice

array of objects

length ≥ 0

Any notice messages.

notice

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

success

array of objects

length ≥ 0

Any success messages.

success

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

warning

array of objects

length ≥ 0

Any warning messages.

warning

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

error

array of objects

length ≥ 0

Any error messages.

error

object

code

integer

Message code. If not applicable, may be omitted or set to '0'.

content

string

The content of the message.

payload

object

The API Payload provides a standard payload format for consumers. It wraps any returned items into the 'items' array and describes the type of those items. It also describes how they have been paginated by the PaidYET API server.

If the called endpoint returns a single item, it will appear as the only object in the 'items' array. Otherwise, the 'items' array will contain all items that resulted from the request.

type

string

The type of data being returned in the payload.

items

array of objects

List of Customers that resulted from the given query parameters.

items

object

integer

Read-only unique identifier.

first_name

string

Customer's first name.

last_name

string

Customer's last name.

contact_media

array of objects

required

Array of Contact Media objects. At least one Contact Media of type email is required.

contact_media*

object

integer

Read-only unique identifier.

type

string

phone, email

phone email

value

string

The actual phone or email address

addresses

array of objects

length ≤ 1

Array of Address objects (limit 1 for now).

addresses

object

integer

Read-only unique identifier.

address

string

Street address.

city

string

The city for the address.

state

string

length ≤ 2

The state code for the address.

postal

integer

The zip code for the address.

custom_fields

array of objects

custom_fields

object

integer

Read-only unique identifier.

key

string

A key for the custom field.

value

string

The value for the custom field given its key.

external_id

string | null

Unique identifier used to look up customer. This is not generated by PaidYET.

count

integer

The total number of items that could have been returned matching the request criteria.

pages

integer

The total number of pages.

page

integer

The number of the page of items returned.

per_page

integer

The number of items per page of this payload.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox-paidyet.com/v3/customer/search \
3
     --header 'accept: application/json'

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

application/json

200PaidYET API Response containing the payload and any messages. The payload's items array contains ZERO to MANY Customers.

400Authentication Token error

401Authentication required