Check if Agent Already Exists in Boost

Verify whether an agent has already been linked to a Boost account using GraphQL queries. This endpoint is part of Boost Integration V2 and uses a separate GraphQL API secret token (not the same as the JWT token used for other V2 endpoints). Use this to determine if an agent needs to be created or if they have an existing account.

post/graphql

Request

Base URL: https://boost.homespotter.com
URL: https://boost.homespotter.com/graphql
Auth: HTTP bearer

Request body

querystring

GraphQL query

variablesobject

Query variables

Example request

{
  "query": "query Agents($partnerShortCode: String, $partnerAgentId: ID!) {\n  agents(partnerShortCode: $partnerShortCode, partnerAgentId: $partnerAgentId, pagination: {first: 1}) {\n    totalCount\n    list {\n      firstName\n      lastName\n      emailAddress\n    }\n  }\n}\n",
  "variables": {
    "partnerShortCode": "YOUR_PARTNER_CODE",
    "partnerAgentId": "agent_12345"
  }
}

Response

GraphQL query executed successfully

Changes

No recorded changes to this operation across all 1 revision of this API.