Get all businesses

GET 
/api/v3/businesses

Retrieve all business

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

Page of items to fetch

per_page integer

Possible values: >= 1

Number of items per page.

search string

Search by business name or city

city string

Filter businesses by city

group_id uuid[]

Filter businesses by access group ID

sort string

Possible values: [created_at, name]

Default value: created_at

Field to sort businesses by

direction string

Possible values: [asc, desc]

Default value: asc

Order direction for sorting

Responses

200

application/json

Schema

Schema

page integerrequired

Possible values: >= 1

Default value: 1

Current page

max_page integerrequired

Possible values: >= 1

Default value: 1

Max page based on current per_page value and count

count integerrequired

Default value: 0

Number of items per page.

items

object[]

required

Array [

id uuidrequired

Unique ID of the guest

access_group_id stringnullable

Access group id that the business belongs to

auto_accept_booking_limit integernullable

Max number of guest in a booking that the business can auto accept

bio stringnullable

Business bio

city stringnullable

City where the business is located

country stringnullable

Country where the business is located

country_code stringnullable

Country code of the business

currency stringnullable

Currency of the business

email stringnullable

Email of the business

facebook_url stringnullable

Facebook page of the business

latitude doublenullable

Latitude of the business

longitude doublenullable

Longitude of the business

has_reservations booleannullable

If the business has reservations enabled

instagram_url stringnullable

Instagram page of the business

logo_url stringnullable

Logo of the business

max_reservation_size integernullable

Max number of guests in a reservation

min_time_before_reservation integernullable

Min time before a reservation can be made

name stringnullable

Name of the business

phone stringnullable

Phone number of the business

post_code stringnullable

Post code of the business

slug stringnullable

Slug of the business

state stringnullable

Possible values: [draft, waiting_for_approval, rejected, published, hidden]

State in which business is

street stringnullable

Street where the business is located

tagline stringnullable

Tagline of the business

time_of_stay integernullable

Default duration of reservation in seconds

time_slots integernullable

Number of time slots available for booking

timezone stringnullable

Timezone of the business

floor_plan_unit_name stringnullable

Name of the floor plan unit

floor_plan_unit_style stringnullable

Possible values: [Style 1, Style 2]

Style of the floor plan uni

website_url stringnullable

Website of the business

youtube_url stringnullable

Youtube page of the business

cover_photo_url stringnullable

Cover photo of the business

photo_urls string[]required

opening_hours

object

nullable

monday string[]required

tuesday string[]required

wednesday string[]required

thursday string[]required

friday string[]required

saturday string[]required

sunday string[]required

]

Example (from schema)

{
  "page": 1,
  "max_page": 1,
  "count": 0,
  "items": [
    {
      "id": "120c50ab-24ae-48f9-8860-ec0e9adea9ec",
      "access_group_id": "ffb0fbe2-9127-4e86-bb5c-46d5cb0f5ca1",
      "auto_accept_booking_limit": 6,
      "bio": "The best gym in town",
      "city": "Paris",
      "country": "France",
      "country_code": "FR",
      "currency": "EUR",
      "email": "power@gym.com",
      "facebook_url": "https://www.facebook.com/powergym",
      "latitude": 48.8566,
      "longitude": 22.3522,
      "has_reservations": true,
      "instagram_url": "https://www.instagram.com/powergym",
      "logo_url": "https://www.powergym.com/logo.png",
      "max_reservation_size": 10,
      "min_time_before_reservation": 30,
      "name": "PowerGym",
      "phone": "+33123456789",
      "post_code": "75019",
      "slug": "power-gym",
      "state": "draft",
      "street": "12 rue du coquelicot",
      "tagline": "The best gym in town",
      "time_of_stay": 2700,
      "time_slots": 10,
      "timezone": "Europe/Paris",
      "floor_plan_unit_name": "Table",
      "floor_plan_unit_style": "Style 1",
      "website_url": "https://www.powergym.com",
      "youtube_url": "https://www.youtube.com/powergym",
      "cover_photo_url": "https://www.powergym.com/cover.png",
      "photo_urls": [
        [
          "https://www.powergym.com/photo1.png"
        ]
      ],
      "opening_hours": {
        "monday": [
          [
            "08:00-12:00"
          ]
        ],
        "tuesday": [
          [
            "08:00-12:00"
          ]
        ],
        "wednesday": [
          [
            "08:00-12:00"
          ]
        ],
        "thursday": [
          [
            "08:00-12:00"
          ]
        ],
        "friday": [
          [
            "08:00-12:00"
          ]
        ],
        "saturday": [
          [
            "08:00-12:00"
          ]
        ],
        "sunday": [
          [
            "08:00-12:00"
          ]
        ]
      }
    }
  ]
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...