To retrieve information about a referral, you can query our GraphQL API using either the referral query (for a specific referral) or the referrals query (to retrieve a list).

​
🔍 Fetching a specific referral

Use the referral(id: ReferralGID!) query to retrieve details about a single referral.
Request
query GetReferralDetails {
  referral(id: "gid://ownright/Referral/1") {
    referral {
      id
      status
      # ... other fields
    }
  }
}
Sample response:
Response
{
  "data": {
    "referral": {
      "id": "gid://ownright/Referral/1",
      "status": "OPEN"
    }
  }
}

​
📋 Fetching multiple referrals

If you don’t know the referral ID or want to browse multiple referrals, you can use the referrals query to list them.
Request
query ListReferrals {
  referrals(first: 10) {
    edges {
      node {
        id
        status
        # ... other fields
      }
    }
  }
}
This query retrieves the first 10 referrals, along with their status.