List vendors

get

https://www.pelcro.com/api/v1/core/vendors

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

limit

int32

Defaults to 10

The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)

page

int32

Defaults to 1

The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.

sort

string

enum

One supported attribute to sort on. Prefix with - for descending.

expand

string

An optional comma separated list of supported relationships to expand. This endpoint supports expanding bills, vendor and vendor.payoutDetail relationships.

filter[id]

string

Filter by vendor ID. Example: eq:42

filter[first_name]

string

Filter by first name. Operators: eq, like. Example: like:John

filter[last_name]

string

Filter by last name. Operators: eq, like. Example: like:Doe

filter[email]

string

Filter by email. Operators: eq, like. Example: like:acme.com

filter[phone]

string

Filter by phone. Example: eq:15551234567

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Request

Response

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

application/json

200Success.

400Invalid request.

401Unauthenticated.