Partner API v3:
- GET Businesses
⚠️ Experimental Version
This version of the API is currently in beta and may undergo changes. For production use, please consider using the current stable version (v2).
Returns every business attached to the selected partner. This endpoint will show 100 businesses at a time, and you may use the "page" parameter to paginate through the results. You can also search businesses using the "name" & "phone" parameters. Relevent location information can be extracted from each business. Be aware that a single business could possibly have multiple BusinessLocation's.
Example
- Resource URL: https://api.voorheesvip.com//v3/partner/{partner_id}/businesses
curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer {access_token}" https://api.voorheesvip.com/v3/partner/{partner_id}/businesses?page={page}
Headers | |
| Content-Type: | (string, required) Must be "application/json" |
| Authorization: | (string, required) Bearer {access_token} |
Parameters | |
| partner_id: | (integer, required) The id of the partner to retrieve businesses for. |
| page: | (integer, optional) The page number to retrieve. Default is 1. |
| search: | (string, optional) The id, name, or phone number of the business to search for. |
Response 200 Status Code
{"status": "success", "results":[{"id":"5569592","name":"Brian's Harley-Davidson","phone":"(215) 752-9400","formatted_address":"600 S Flowers Mill Rd, Langhorne, PA 19047, USA","website":"http://www.brianshd.com","status":"Active"}, {"...":"repeat for each business"}]}