ZenotiHelp

Form ID Lookup Helpers for Guest HTML Data and Tag Appointments

ZTZenoti Docs Team Updated September 4, 2026 5 min readGuide

Zenoti provides two lookup helpers that retrieve the form ID of the most recent non-voided form record for a given context: one for guest HTML forms and one for tag forms associated with an appointment. Use these helpers when you need to identify which form record to open, review, or act on for a specific guest or appointment-tag combination.

Audience: Zenoti administrators and integration configurators who manage form workflows and need to locate specific form records programmatically or through support-assisted troubleshooting.


On this page


Before you begin

  • Your organization must have at least one active guest HTML form or tag form configured.

  • The guest record must exist in your organization before you attempt a guest HTML form lookup.

  • The appointment must be associated with a tag before you attempt a tag form lookup.

  • You need the following permissions:

    Permission: Edit under CustomFields in the Administrator section of the security role β€” Required to view and manage guest custom data and form records.

    Permission: View under GuestCustomData in the Guest Manager section of the security role β€” Required to access guest-level form records.

Note: These lookup helpers return only the most recent non-voided form record for the given context. If a guest or appointment has multiple form records, only the latest non-voided record is returned.

Steps

Look up the form ID for a guest HTML form

Use this lookup when you need to identify the most recent non-voided guest HTML form record for a specific guest in your organization. The lookup targets guest-type form records (owner type: Guest).

  1. Confirm that the guest has at least one submitted or in-progress guest HTML form record in your organization.

  2. Identify the guest's record in Zenoti β€” navigate to the guest profile to confirm the guest ID and organization association.

  3. Contact your Zenoti administrator or use the supported form management interface to request the form ID lookup for the guest HTML form record.

    The lookup returns the FormId of the most recent non-voided guest HTML form record associated with the guest and organization.

  4. Use the returned form ID to navigate to, review, or act on the specific form record.

Note: The lookup returns only one form ID β€” the most recent non-voided record. If you need to review older form records, use the form review workflow or the forms report.

Tip: To review or act on the form once you have the form ID, see Form Review & Assignee Workflow.


Look up the form ID for a tag appointment form

Use this lookup when you need to identify the most recent non-voided tag form record for a specific appointment, tag, and user combination. The lookup targets tag-type form records (owner type: Tag).

  1. Confirm that the appointment has an associated tag and that a tag form record exists for the appointment.

  2. Identify the appointment ID, the tag associated with the appointment, and the user (provider) linked to the form record.

  3. Contact your Zenoti administrator or use the supported form management interface to request the form ID lookup for the tag appointment form record.

    The lookup returns the FormId of the most recent non-voided tag form record for the given appointment, tag, and user combination.

  4. Use the returned form ID to navigate to, review, or act on the specific tag form record.

Note: Tag forms are scoped to a specific appointment, tag, and user combination. If the same appointment has multiple tags, each tag has its own form record. Ensure you provide the correct tag identifier when requesting the lookup.

Note: The number of tag form slots available per appointment is controlled by an organization-level setting. Contact your administrator if you expect more tag form records than are visible.

Tip: For an overview of how tag forms relate to other form types, see Forms Overview.


Worked example:

A front desk manager needs to locate the correct form record before a provider review session. Guest "Maria Chen" has submitted multiple guest HTML forms over the past year. The manager requests a guest HTML form ID lookup for Maria's guest record. The lookup returns the form ID for Maria's most recent non-voided guest HTML form β€” for example, form ID 10482 β€” which the manager then opens directly in the form review interface to assign a reviewer.

For a tag form scenario: Provider "Alex Rivera" completed a tag form for appointment #20091 under the "Post-Treatment" tag. The manager requests a tag form ID lookup for that appointment, tag, and provider combination. The lookup returns the form ID for the most recent non-voided tag form record β€” for example, form ID 10519 β€” which the manager uses to open the record for review.


Tips

  • Always confirm the guest ID, organization, appointment ID, tag, and user before requesting a lookup. Providing incorrect identifiers returns results for the wrong record.
  • If the lookup returns no result, verify that a non-voided form record exists for the given context. Voided form records are excluded from lookup results.
  • Use the form review workflow after retrieving a form ID to assign reviewers, update form fill status, or complete the review process. See Form Review & Assignee Workflow.
  • Tag form lookups are scoped to a specific appointment, tag, and user combination. If you need to locate form records across multiple tags on the same appointment, perform a separate lookup for each tag.
  • For bulk form management tasks β€” such as reviewing multiple form records at once β€” use the forms report rather than individual lookups. See Reporting.

Troubleshooting

Problem Likely cause Resolution
Lookup returns no form ID for a guest No non-voided guest HTML form record exists for the guest and organization combination Confirm the guest has submitted or started a guest HTML form. Check whether the form record was voided. If the form was voided, a new form submission is required.
Lookup returns no form ID for a tag appointment No non-voided tag form record exists for the appointment, tag, and user combination Confirm the appointment has the correct tag associated and that the provider completed or started the tag form. Verify the user identifier matches the provider linked to the form record.
Returned form ID does not match the expected form Multiple form records exist; the lookup returns only the most recent non-voided record If you need an older form record, use the form review interface or the forms report to locate records by date range or form fill status. See Reporting.
Tag form record not visible after lookup The organization-level tag form slot limit may restrict the number of visible tag form records Contact your Zenoti administrator to review the tag form slot configuration for your organization.
Guest HTML form lookup returns a record from a different organization Guest record is associated with multiple organizations Confirm the correct organization is specified in the lookup request. Guest HTML form records are scoped to a specific guest and organization combination.
Was this article helpful?
Your feedback helps us improve our documentation.