Link Search Menu Expand Document

Getting a business



  • Call name: get-business
  • Endpoint URL:
  • Request methods: GET
  • Response Content-Type: application/json
  • Auth required: yes

In Spaaza terminology, a “business” is a branch of a retailer (a “chain”). This API call gets the details of a business.

Version-specific information

The following version-specific changes apply to this endpoint. See the versioning page for more details.

Version Change details

Permissions and Authentication

This API call requires a valid Spaaza session. See the authentication page for more details. The session can be as follows:

  • Admin authentication: The performing user needs to be logged in and have read access to the chain to which the user is connected.


The following headers can/must be passed to the API call:

Parameter Description

HTTP Parameters

The following HTTP parameters can be passed to the API:

Parameter Description
business_id (integer, mandatory) The id of the business you wish to fetch.

Example response JSON

The endpoint returns JSON showing the details associated with the business. An example response is shown below:

    "result": {
        "code": 1,
        "status": "ok"
    "results": {
        "business": {
            "address_1": "Herengracht 504",
            "address_2": null,
            "address_3": null,
            "business_format": "Metro",
            "chain_id": 1743,
            "countrycode": "NL",
            "deleted": false,
            "deleted_by": null,
            "email_address": "",
            "format": "Metro",
            "google_place_id": "ChIJMaAAt6KjMRkRwxomyCkN71w",
            "id": 1383,
            "image_url": "",
            "is_shut_down": false,
            "latitude": "52.37021570",
            "longitude": "1.89516789",
            "name": "ACME Inc",
            "opening_times": "{\"monday\": {\"open\": \"11:00\",\"close\": \"18:00\" }, \"tuesday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"wednesday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"thursday\": { \"open\": \"09:30\", \"close\": \"18:00\" }, \"friday\": { \"open\": \"09:30\", \"close\": \"21:00\" }, \"saturday\": { \"open\": \"09:30\", \"close\": \"17:00\" }, \"sunday\": { \"open\": \"Elke laatste zondag van de maand\", \"close\": \"12:00-17:00\" }, \"special_hours\": [ { \"date\": \"23\/02\/2020\", \"open\": \"12:00\", \"close\": \"17:00\", \"reason\": \"Laatste zondag van de maand\" }, { \"date\": \"23\/02\/2020\", \"open\": \"-\", \"close\": \"-\", \"reason\": \"Carnaval\" } ] }",
            "owner_code": "10001",
            "phone_number": "0124141",
            "postalcode": "1017 CB",
            "programme_opted_in": true,
            "region": "Noord Holland",
            "towncity": "Amsterdam",
            "review_url" : "",
            "type": "business",
            "website_url": ""
        "result_type": "get-business"