Return all guests for specific business

GET 
/api/v1/businesses/:id/guests

Return all guests for specific business

Request

Path Parameters

id int32required

Query Parameters

search string

Search query by first_name, last_name or email

page int32

Default value: 1

Page offset to fetch.

per_page int32

Default value: 10

Number of results to return per page.

Responses

200

Return all guests for specific business

application/vnd.api+json

Schema

Schema

data

object[]

required

Array [

id stringrequired

type stringrequired

Possible values: [guests]

links

object

required

self stringrequired

attributes

object

required

email stringrequired

first-name stringrequired

last-name stringrequired

birthday stringnullablerequired

phone stringnullablerequired

phone-country-code stringnullablerequired

phone-country-prefix stringnullablerequired

tags string[]required

general-note stringnullablerequired

visit-note stringnullablerequired

marketing-agreement boolean

]

meta

object

required

total-count numberrequired

total-pages numberrequired

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "guests",
      "links": {
        "self": "string"
      },
      "attributes": {
        "email": "string",
        "first-name": "string",
        "last-name": "string",
        "birthday": "string",
        "phone": "string",
        "phone-country-code": "string",
        "phone-country-prefix": "string",
        "tags": [
          "string"
        ],
        "general-note": "string",
        "visit-note": "string",
        "marketing-agreement": true
      }
    }
  ],
  "meta": {
    "total-count": 0,
    "total-pages": 0
  }
}

Example

{
  "data": [
    {
      "id": "5c12333e-62ac-4640-af6c-66bf51a86c14",
      "type": "guests",
      "links": {
        "self": "/guests/5c12333e-62ac-4640-af6c-66bf51a86c14"
      },
      "attributes": {
        "email": "john@email.com",
        "first-name": "John",
        "last-name": "Smith",
        "birthday": null,
        "phone": "127834563",
        "phone-country-code": "FR",
        "phone-country-prefix": "33",
        "tags": [],
        "general-note": null,
        "visit-note": null,
        "marketing-agreement": false
      }
    }
  ],
  "meta": {
    "total-count": 22,
    "total-pages": 3
  }
}

Loading...