engagement query with
the engagement’s GID. Since the Engagement type is an interface implemented by
PurchaseEngagement and RefinanceEngagement, you’ll use inline fragments to access
type-specific fields.
Fetching a single engagement
Use theengagement(id: EngagementGID!) query to retrieve details about one engagement:
Request
Variables
Response
Understanding inline fragments
Since theengagement query returns the Engagement interface, you need inline fragments
to access the concrete type’s fields. The interface provides a common set of fields
(id, shortId, type, owner, clients, createdAt), but type-specific fields
like closingDate, property, and status are only available on the concrete types.
The
status field is itself an interface with multiple concrete status types
(one per state). Each status type currently exposes a state field, but this
pattern allows for additional status-specific fields to be added in the future
without breaking changes.Handling a null response
If the engagement ID doesn’t exist or you don’t have access to it, the query returnsnull:
Next steps
Cancelling an engagement
Learn how to cancel an engagement that is no longer needed.
File uploads
Learn the staged upload flow for attaching mortgage documents.