List stores

Returns a list of stores associated with the company that the API key was issued for.
Each store includes basic information, hours, and manufacturer-assigned tags and types.

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

Specifies the field to sort by. To sort in descending order, add "-" in the beginning. Allowed values:

  • id
  • name
  • created_at
  • updated_at

Default is id.

integer

Page number for pagination. Must be a positive integer.

integer

Number of results on a page. Defaults to 10.

string

Filters results by a specific field. Allowed values:

  • name
  • city
  • state
  • phone
  • email
  • website
  • address_1
  • address_2
  • address_3
  • country
  • postal_code
  • radius (requires postal_code; miles)
  • bfg_verified
  • self_verified
  • tags
  • types
  • all
  • full_address
  • search
  • name_starts_with
  • hours
  • missing_hours
string

Filter by trashed status. Allowed values:

  • true
  • false
  • with

Default is without.

Responses

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