Sign in
V2Businesses

Fetch Businesses

post/v2/businesses

Request body

request_contextobject nullable
mode'full' | 'preview' required

The BaseFetchMode class is an enumeration that defines the modes for fetching data.

This enum is used to specify whether the fetch operation should retrieve the full data or just a preview of the data. It ensures consistent handling of fetch modes across the application.

Attributes: FULL: Fetch the complete data. PREVIEW: Fetch a preview or partial data.

page_sizeinteger required

The maximum number of businesses in a page.

excludestring[] nullable
next_cursorstring nullable

Cursor returned by the previous page. Omit or send null to start from the beginning.

Example request

{
  "page_size": 3,
  "filters": {}
}

Response

Successful Response

total_resultsinteger

The total number of businesses that match the filters.

Changes

Changed in 3 of the 11 revisions of this API.212

  • dd1993e90c4311See the full diff
    • ▲

      added to the // request property allOf list

      request-property-all-of-added

    • ●

      removed from the // request property allOf list

      request-property-all-of-removed

  • bcf3eb6e643011See the full diff
    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ○

      added the required property / to the response with the status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6b092e43b8931See the full diff
    • ○

      endpoint added

      endpoint-added