Eagle API Documentation

Introduction

The Eagle API gives you programmatic access to Eagle property management data — properties, contacts, appraisals, listings, and more — via a single GraphQL endpoint.

Authentication uses a simple two-step flow: exchange your client_id and client_secret for a short-lived session token, then include that token as a Bearer header on every GraphQL request.

How it works

Step 1 — Create API credentials

Before you can request a token you need a client_id and client_secret pair from the Eagle application.

1. Go to https://www.eagleagent.com.au/agent and sign in.
2. Click Settings in the top-right corner.
3. Click API Credentials in the left-hand navigation.
4. Click New Credentials.
5. Enter a description (e.g. My Integration) and click Create.
6. Your new credentials appear in the list. Click show to reveal the client secret.

Step 2 — Request a session token

POST to the token endpoint with your credentials in the Authorization header using the format client_id:client_secret. The returned token is valid for 24 hours.

Endpoint

POST https://www.eagleagent.com.au/api/v3/token

Headers

Example — cURL

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 5889796789559:230408972308020237838' \
  https://www.eagleagent.com.au/api/v3/token

{
  "data": {
    "token": {
      "token": "eyJ0eXAfKV1QiLCJhbGciOiJIUzI1NiJ9....",
      "expiresAt": 1582206763
    }
  }
}

Step 3 — Make a GraphQL request

Include the session token in every request to the GraphQL endpoint using the Authorization: Bearer TOKEN header.

Endpoint

POST https://www.eagleagent.com.au/api/v3/graphql

Required headers

Request body

Send a JSON body with a query field containing your GraphQL query string, and optionally a variables object.

{
  "query": "query { ... }",
  "variables": { "key": "value" }
}

Example — list properties

This example fetches the first page of properties with address, coordinates, and vendor details.

GraphQL query

query GetProperties {
  properties {
    nodes {
      id
      formattedAddress
      latitude
      longitude
      vendors {
        contact {
          firstName
          lastName
        }
      }
    }
  }
}

Full cURL request

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer eyJ0eXAfKV1QiLCJhbGciOiJIUzI1NiJ9....' \
  --data '{
    "query": "query GetProperties { properties { nodes { id formattedAddress latitude longitude vendors { contact { firstName lastName } } } } }"
  }' \
  https://www.eagleagent.com.au/api/v3/graphql

Using variables (recommended)

Pass dynamic values as variables rather than inlining them in the query string.

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer eyJ0eXAfKV1QiLCJhbGciOiJIUzI1NiJ9....' \
  --data '{
    "query": "query GetProperty($id: ID!) { property(id: $id) { id formattedAddress } }",
    "variables": { "id": "42" }
  }' \
  https://www.eagleagent.com.au/api/v3/graphql

Example response

All GraphQL responses follow the same envelope structure: a top-level data object containing your result, and an optional errors array.

{
  "data": {
    "properties": {
      "nodes": [
        {
          "id": "1",
          "formattedAddress": "1366 May Locks, EUROA",
          "latitude": -36.7247,
          "longitude": 145.9944,
          "vendors": []
        },
        {
          "id": "3",
          "formattedAddress": "4831 Konopelski Summit, EUROA",
          "latitude": -36.8443,
          "longitude": 145.7846,
          "vendors": []
        }
      ]
    }
  }
}

{
  "data": null,
  "errors": [
    {
      "message": "Not authorized to access this resource",
      "locations": [{ "line": 2, "column": 3 }],
      "path": ["properties"]
    }
  ]
}

Implementation notes

• Always send requests as POST — the GraphQL endpoint does not support GET.
• Set Content-Type: application/json on every request.
• Pass the session token as Authorization: Bearer TOKEN.
• Tokens expire after 24 hours (Unix timestamp in expiresAt). Re-request a token before it expires.
• Use variables instead of string interpolation to pass dynamic values into queries.
• Use the schema explorer to discover exact field names, argument types, and available operations.
• GraphQL responses can return partial data alongside errors — always check the errors array even when data is present.
• Never expose client_id or client_secret in frontend or mobile code.

Common errors

API reference

Useful links for further exploration and integration.