ChangelogGuidesRecipesAPI ReferenceRoadmap
HomeGuidesRecipesAPI ReferenceChangelog
ChangelogGuidesRecipesAPI ReferenceRoadmapSTART FREE TRIALSCHEDULE A DEMO
API Reference
START FREE TRIALSCHEDULE A DEMO

List vendors

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

Retrieve a paginated list of vendors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
required

The unique identifier of the site associated with your account.

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.

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)

string

Search vendors by name, email, or phone.

string

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

string
enum

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

string

Filter by vendor ID. Example: eq:42

string

Filter by first name. Example: like:jane

string

Filter by last name. Example: like:smith

string

Filter by email. Example: like:example.com

string

Filter by phone. Example: like:555

Headers
string
required
Defaults to Bearer eyJ***
Responses

Updated 20 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago