Get all guests within a business

GET 
/api/v2/businesses/:business_id/guests

Retrieve all the guests within a specific business

Request

Path Parameters

business_id stringrequired

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 query by first_name, last_name or email
Example: John

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

email emailrequired

Email of the guest

first_name stringrequired

First name of the guest

last_name stringrequired

Last name of the guest

birthday datenullable

Birthday of the guest

phone stringnullable

Possible values: >= 6 characters and <= 15 characters, Value must match regular expression ^[0-9]*$

Phone number of the guest

phone_country_code stringnullable

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Country code of the phone number

phone_country_prefix stringnullable

Possible values: non-empty and <= 4 characters, Value must match regular expression ^[0-9]+$

Country prefix of the phone number

tags string[]required

general_note stringnullable

General note about the guest

visit_note stringnullable

Note about the guest's visit

]

Example (from schema)

{
  "page": 1,
  "max_page": 1,
  "count": 0,
  "items": [
    {
      "id": "120c50ab-24ae-48f9-8860-ec0e9adea9ec",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "birthday": "1990-01-01",
      "phone": "789998877",
      "phone_country_code": "CH",
      "phone_country_prefix": "41",
      "tags": [
        "VIP"
      ],
      "general_note": "VIP customer",
      "visit_note": "Birthday party"
    }
  ]
}

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...