Engage API | Genaya API Reference

Engage

Your public profile, reviews, forms and booking pages, and what they collect.

GET/engage-profiles

List engage profiles

Returns the organization's public Engage profile. Read-only. Requires scope: engage:read.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-profiles \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_profile",
      "companyName": "",
      "description": "",
      "logoUrl": "",
      "categories": [
        ""
      ],
      "services": [
        ""
      ],
      "reviewCount": 0,
      "averageRating": 0,
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-profiles/{id}

Retrieve a engage profile

Returns a single engage profile by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

companyName

string

description

string

logoUrl

string

nullable

categories

array of string

services

array of string

reviewCount

integer

nullable

averageRating

number

nullable

updatedAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-profiles/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_profile",
    "companyName": "",
    "description": "",
    "logoUrl": "",
    "categories": [
      ""
    ],
    "services": [
      ""
    ],
    "reviewCount": 0,
    "averageRating": 0,
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/engage-reviews

List reviews

Returns customer reviews. The reviewer's email, IP address and geolocation are never exposed. Read-only. Requires scope: engage:read.

Parameters

Query

publicVisible

string

Return only reviews matching this publicVisible.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-reviews \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_review",
      "rating": 0,
      "body": "",
      "imageCount": 0,
      "authorName": "",
      "verified": false,
      "source": "",
      "companyId": "",
      "publiclyVisible": false,
      "reply": {
        "body": "",
        "repliedAt": "2026-01-15T09:30:00.000Z"
      },
      "submittedAt": "2026-01-15T09:30:00.000Z",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-reviews/{id}

Retrieve a review

Returns a single review by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

rating

number

nullable

body

string

imageCount

integer

authorName

string

Display name only

verified

boolean

True when the review is tied to a real job.

source

string

nullable

companyId

string

nullable

publiclyVisible

boolean

reply

object

nullable

body

string

repliedAt

string <date-time>

nullable

submittedAt

string <date-time>

createdAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-reviews/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_review",
    "rating": 0,
    "body": "",
    "imageCount": 0,
    "authorName": "",
    "verified": false,
    "source": "",
    "companyId": "",
    "publiclyVisible": false,
    "reply": {
      "body": "",
      "repliedAt": "2026-01-15T09:30:00.000Z"
    },
    "submittedAt": "2026-01-15T09:30:00.000Z",
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/engage-forms

List forms

Returns published Engage forms. Read-only. Requires scope: engage:read.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-forms \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_form",
      "name": "",
      "description": "",
      "leadTableId": "",
      "submissionCount": 0,
      "lastSubmissionAt": "2026-01-15T09:30:00.000Z",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-forms/{id}

Retrieve a form

Returns a single form by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

leadTableId

string

nullable

submissionCount

integer

nullable

lastSubmissionAt

string <date-time>

nullable

createdAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-forms/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_form",
    "name": "",
    "description": "",
    "leadTableId": "",
    "submissionCount": 0,
    "lastSubmissionAt": "2026-01-15T09:30:00.000Z",
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/engage-form-submissions

List form submissions

Returns answers submitted through Engage forms. Read-only. Requires scope: engage:read.

Parameters

Query

formId

string

Return only form submissions matching this formId.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-form-submissions \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_form_submission",
      "formId": "",
      "answers": {},
      "submittedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-form-submissions/{id}

Retrieve a form submission

Returns a single form submission by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

formId

string

nullable

answers

object

The answers as submitted, keyed by field.

submittedAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-form-submissions/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_form_submission",
    "formId": "",
    "answers": {},
    "submittedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/engage-bookings

List booking pages

Returns published Engage booking pages. Read-only. Requires scope: engage:read.

Parameters

Query

companyId

string

Return only booking pages matching this companyId.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-bookings \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_booking",
      "name": "",
      "description": "",
      "companyId": "",
      "companyName": "",
      "lastSubmissionAt": "2026-01-15T09:30:00.000Z",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-bookings/{id}

Retrieve a booking page

Returns a single booking page by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

companyId

string

nullable

companyName

string

nullable

lastSubmissionAt

string <date-time>

nullable

createdAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-bookings/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_booking",
    "name": "",
    "description": "",
    "companyId": "",
    "companyName": "",
    "lastSubmissionAt": "2026-01-15T09:30:00.000Z",
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/engage-booking-submissions

List booking submissions

Returns bookings made through Engage booking pages. Read-only. Requires scope: engage:read.

Parameters

Query

bookingId

string

Return only booking submissions matching this bookingId.

companyId

string

Return only booking submissions matching this companyId.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-booking-submissions \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "engage_booking_submission",
      "bookingId": "",
      "appointmentId": "",
      "appointmentTypeId": "",
      "appointmentTypeName": "",
      "name": "",
      "email": "",
      "phone": "",
      "address": "",
      "city": "",
      "description": "",
      "depositAmount": 0,
      "depositPaid": false,
      "companyId": "",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/engage-booking-submissions/{id}

Retrieve a booking submission

Returns a single booking submission by id. A record belonging to another organization returns 404 rather than 403. Requires scope: engage:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

bookingId

string

nullable

appointmentId

string

nullable

appointmentTypeId

string

nullable

appointmentTypeName

string

nullable

name

string

email

string

phone

string

address

string

city

string

description

string

depositAmount

number

nullable

depositPaid

boolean

companyId

string

nullable

createdAt

string <date-time>

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/engage-booking-submissions/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "engage_booking_submission",
    "bookingId": "",
    "appointmentId": "",
    "appointmentTypeId": "",
    "appointmentTypeName": "",
    "name": "",
    "email": "",
    "phone": "",
    "address": "",
    "city": "",
    "description": "",
    "depositAmount": 0,
    "depositPaid": false,
    "companyId": "",
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}