API - Guest Grow

Authentication

Send your client ID and secret

Every request carries your client ID and secret as HTTP Basic auth. There is no token to fetch or refresh.

AuthBasic client ID and secret

Call the API from your server, never from browser code
20 failed sign-ins per 15 minutes from one address
Ask us for a new secret if it ever leaks

Headers

AuthorizationBasic base64(clientId:secret)Required
Most HTTP clients build this from a username and password. Use your client ID and secret.

Example request

curl https://api.guestgrow.co.za/api/client-portal/properties \
  -u "YOUR_CLIENT_ID:YOUR_SECRET"

Response 401

{
  "message": "Access denied. The provided secret is not associated with the client ID."
}

Properties

List properties

Returns your properties a page at a time, so your enquiry form can offer them and your site can show them.

AuthBasic client ID and secret

10 per page by default, up to 100
Use the images only to promote these properties

Query

pagenumber, default 1
limitnumber, default 10, up to 100
searchstring
Matches the name, street, city or postal code.

Each property

id, namestring
descriptionstring
street, city, postalCodestring
Street and postal code can be empty.
imagesstring[]
Image addresses.
inclusions, exclusionsstring[]
websitestring or null

Example request

curl "https://api.guestgrow.co.za/api/client-portal/properties?page=1&limit=10" \
  -u "YOUR_CLIENT_ID:YOUR_SECRET"

Response 200

{
  "data": [
    {
      "id": "3b1e0c9a-0000-0000-0000-000000000000",
      "name": "Example River Lodge",
      "description": "Eight suites on the river...",
      "street": "1 River Road",
      "city": "Hoedspruit",
      "postalCode": "1380",
      "images": ["https://.../lodge-1.jpg"],
      "inclusions": ["Two game drives daily"],
      "exclusions": ["Conservation levy"],
      "website": "https://example.com"
    }
  ],
  "total": 12,
  "message": "Successfully returned properties."
}

Enquiries

Create enquiry

Sends a guest's enquiry to the Guest Grow team, who take it from there.

AuthBasic client ID and secret

Fields not listed here are rejected
Every property must be one of yours
An identical enquiry is turned away

Body

firstName, lastName, emailstringRequired
mobileNumber, country, commentstringRequired
propertiesstring[]Required
Property IDs from List properties. Send an empty list if the guest has not picked one.
travelTypeenumRequired
SOLOCOUPLEFAMILYGROUPSPECIAL_OCCASIONSHONEYMOON
sourceenumRequired
WEBSITE_ENQUIRYONLINE_BOOKINGRESERVATIONSREFERRALSOCIAL_MEDIAREPEATPRIVATE_TRAVEL
startDate, endDateISO 8601 dateRequired
adults, childrennumberRequired
childrenAgesnumber[]Required
One age per child.

Example request

curl -X POST https://api.guestgrow.co.za/api/client-portal/enquiries \
  -u "YOUR_CLIENT_ID:YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane@example.com",
    "mobileNumber": "+27 82 000 0000",
    "country": "South Africa",
    "properties": ["3b1e0c9a-0000-0000-0000-000000000000"],
    "travelType": "FAMILY",
    "adults": 2,
    "children": 1,
    "childrenAges": [8],
    "startDate": "2027-06-15",
    "endDate": "2027-06-20",
    "source": "WEBSITE_ENQUIRY",
    "comment": "Celebrating a birthday."
  }'

Response 200

{ "message": "Enquiry created successfully." }

Enquiries straight to Guest Grow

A guest enquires

It comes straight to us

We take it from there

Connect your enquiry form

Send your client ID and secret

List properties

Create enquiry

Errors and limits

Already a client? Let's connect your website