Referrals
Referral by ID
Reference for fetching a referral by ID
Copy
query GetReferralByID($id: ReferralGID!) {
referral(id: $id) {
id
status
}
}
Copy
{
"data": {
"referral": {
"id": "gid://ownright/Referral/1"
"status": "OPEN"
}
}
}
Copy
query GetReferralByID($id: ReferralGID!) {
referral(id: $id) {
id
status
}
}
Copy
{
"data": {
"referral": {
"id": "gid://ownright/Referral/1"
"status": "OPEN"
}
}
}
Query field
referral
Arguments
Return fields
The fetched referral.
Types
Copy
"""
Represents a referral.
"""
interface Referral implements Node {
"""
The contacts for the referral.
"""
contacts: [ReferralContact!]!
"""
The time the referral was created.
"""
createdAt: ISO8601DateTime!
"""
The custom attributes for the referral.
"""
customAttributes: [CustomAttribute!]!
"""
ID of the object.
"""
id: GID!
"""
The primary contact for the referral.
"""
primaryContact: ReferralContact!
"""
The current status of the referral.
"""
status: ReferralStatus!
"""
The type of the referral.
"""
type: ReferralType!
"""
The time the referral was updated.
"""
updatedAt: ISO8601DateTime!
}
"""
A contact for a referral.
"""
type ReferralContact implements Node {
"""
The email of the contact.
"""
email: String!
"""
The first name of the contact.
"""
firstName: String!
"""
ID of the object.
"""
id: GID!
"""
Whether the contact is the primary contact.
"""
isPrimary: Boolean!
"""
The last name of the contact.
"""
lastName: String!
"""
The phone number of the contact.
"""
phoneNumber: String
"""
Whether the contact prefers to be phoned.
"""
prefersToBePhoned: Boolean
}
"""
A referral for a refinance.
"""
type RefinanceReferral implements Node & Referral {
"""
The contacts for the referral.
"""
contacts: [ReferralContact!]!
"""
The time the referral was created.
"""
createdAt: ISO8601DateTime!
"""
The custom attributes for the referral.
"""
customAttributes: [CustomAttribute!]!
"""
ID of the object.
"""
id: GID!
"""
The amount of the new mortgage involved in the refinance.
"""
mortgageAmount: Money
"""
The primary contact for the referral.
"""
primaryContact: ReferralContact!
"""
The address of the property that is involved in the refinance.
"""
propertyAddress: Address
"""
The current status of the referral.
"""
status: ReferralStatus!
"""
The type of the referral.
"""
type: ReferralType!
"""
The time the referral was updated.
"""
updatedAt: ISO8601DateTime!
}
"""
A referral for a sale property closing.
"""
type SalePropertyClosingReferral implements Node & Referral {
"""
The contacts for the referral.
"""
contacts: [ReferralContact!]!
"""
The time the referral was created.
"""
createdAt: ISO8601DateTime!
"""
The custom attributes for the referral.
"""
customAttributes: [CustomAttribute!]!
"""
ID of the object.
"""
id: GID!
"""
The primary contact for the referral.
"""
primaryContact: ReferralContact!
"""
The address of the property being sold.
"""
propertyAddress: Address
"""
The current status of the referral.
"""
status: ReferralStatus!
"""
The type of the referral.
"""
type: ReferralType!
"""
The time the referral was updated.
"""
updatedAt: ISO8601DateTime!
}
"""
A referral for a status certificate review.
"""
type StatusCertificateReviewReferral implements Node & Referral {
"""
Indicates whether the client has made an offer on a property already or not.
"""
clientHasMadeOffer: Boolean!
"""
The contacts for the referral.
"""
contacts: [ReferralContact!]!
"""
The time the referral was created.
"""
createdAt: ISO8601DateTime!
"""
The custom attributes for the referral.
"""
customAttributes: [CustomAttribute!]!
"""
Indicates whether the status certificate review requires an earlier than normal review.
"""
earlyDeadlineRequest: Boolean!
"""
ID of the object.
"""
id: GID!
"""
The preferred completion time for the status certificate review.
"""
preferredCompletionTime: ISO8601DateTime
"""
The primary contact for the referral.
"""
primaryContact: ReferralContact!
"""
The address of the property that is involved in the status certificate review.
"""
propertyAddress: Address
"""
The current status of the referral.
"""
status: ReferralStatus!
"""
The type of the referral.
"""
type: ReferralType!
"""
The time the referral was updated.
"""
updatedAt: ISO8601DateTime!
}
"""
A referral for a purchase property closing.
"""
type PurchasePropertyClosingReferral implements Node & Referral {
"""
The contacts for the referral.
"""
contacts: [ReferralContact!]!
"""
The time the referral was created.
"""
createdAt: ISO8601DateTime!
"""
The custom attributes for the referral.
"""
customAttributes: [CustomAttribute!]!
"""
ID of the object.
"""
id: GID!
"""
The primary contact for the referral.
"""
primaryContact: ReferralContact!
"""
The address of the property being purchased.
"""
propertyAddress: Address
"""
The amount of money to purchase the property.
"""
purchaseAmount: Money
"""
The current status of the referral.
"""
status: ReferralStatus!
"""
The type of the referral.
"""
type: ReferralType!
"""
The time the referral was updated.
"""
updatedAt: ISO8601DateTime!
}
Copy
query GetReferralByID($id: ReferralGID!) {
referral(id: $id) {
id
status
}
}
Copy
{
"data": {
"referral": {
"id": "gid://ownright/Referral/1"
"status": "OPEN"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.