Localtunity Network

#Api Documentation

REST API v2

Format: JSON

All responses will be in JSON format. All api calls should take the format https://api.localtunity.com/v2/[resource]

Changes From API V1
  • - No longer allow location information on POST businesses endpoint.
  • - No longer allow editing location information on PUT businesses/:id endpoint.
  • - Add locations for a business at POST businesses/:id/locations endpoint.
  • - Edit an existing location for the business at PUT businesses/:id/locations/:location-id endpoint.
  • - Delete a location for the business at DELETE businesses/:id/locations/:location-id. This is only available if you were the original creator of the location.
  • - Rename 'phone' parameter to 'phone_one' for businesses endpoint.
  • - Unauthorized requests or expired access tokens return a 401 status code.
  • - Non-existing GET requests will return a 404 status code.
  • - Invalid requests return a 4xx status code.
  • - Invalid requests can return multiple error messages.

Access Token In order to make authorized calls to Localtunity’s API, your application must first obtain an OAuth access token

Resource Description
POST token Returns an access token used to make authorized calls to the Localtunity API.

Businesses All businesses in the localtunity network. Location information included.

Resource Description
GET partners Returns every sublicensee in the localtunity network.
GET businesses Returns every business in the localtunity network. Relevent location information can be extracted from each business.
GET businesses/:id Returns a single business in the localtunity network with id equal to the ID parameter.
POST businesses Creates a business in the localtunity network.
PUT businesses/:id Updates a single business in the localtunity network with id equal to the ID parameter.
POST businesses/:id/locations Add an additional location to an existing business.
PUT businesses/:id/locations/:location-id Update an existing location for a business.
DELETE businesses/:id/locations/:location-id Delete an existing location for a business.
POST businesses/:id/upload-image Special endpoint that handles uploading images for businesses.
POST businesses/:id/reviews Allows for a consumer to post a review for a business.

Categories Businesses can be assigned to categories.

Resource Description
GET categories Returns a list of available business categories.