API Reference

Get Service Areas

Get a list of all the merchant's service areas. You can also get a list of all service areas assigned to a specific team.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

next_page_cursor

The ID to retreive the next page of results.

id

Int32

The unique ID for this record.

external_id

string

Your ID for this record.

name

string

The display name of this record.

polygon

array_string

The coordinates that form a polygon that defines the service area.

zipcodes

array_string

The zip codes included in the service area.

zipcode_reached_limit

boolean

Bringg displays up to 57001 zip codes per service area.

  • false - below limit.
  • true - above limit.
Language