Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Green Dot

Fetch Green Dot Retail Locations

get/greendot/location

Query parameters

ip_addressstring

IP address of the client device making this request. Filterable.

latitudestring

Latitude of the retail location. Required along with longitude if zip_code is not provided. Filterable.

longitudestring

Longitude of the retail location. Required along with latitude if zip_code is not provided. Filterable.

zip_codestring

Zip code/Postal code of the retailer. Required if latitude and longitude are not provided. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size greendot_location elements, starting after the greendot_location described by page_cursor. If no more greendot_locations are available, the resulting list will be empty.