Query Address Cleanser requests

Retrieving a single Address Cleanser request

Use the addressCleanserRequest query with the id returned from the cleanseAddress mutation.

JavaScript

const bodyJSON = {
  variables: {
    id: "6820a4f3e1c2b5d8f0123456",
  },
  query: `
query ($id: ID!) {
  addressCleanserRequest(id: $id) {
    id
    originalAddress {
      building
      streetNo
      street
      suburb
      state
      postcode
      country
    }
    cleansedAddress {
      building
      streetNo
      street
      suburb
      state
      postcode
      country
    }
    recommendation
    score
    createdAt
    billable
  }
}`,
};

GraphQL Query

Variables

Response

The query returns null if no request with the supplied id exists on your account.

Retrieving all your Address Cleanser requests

JavaScript

const bodyJSON = {
  variables: {
    input: {},
  },
  query: `
query ($input: AddressCleanserQueryInput) {
  addressCleanserRequests(input: $input) {
    id
    recommendation
    score
    createdAt
  }
}`,
};

GraphQL Query

Variables

Response

Filtering Address Cleanser requests

Use the input parameter to narrow results by recommendation or date range.

JavaScript

const bodyJSON = {
  variables: {
    input: {
      recommendation: "approve",
      minCreatedAt: "2026-06-01T00:00:00.000Z",
      maxCreatedAt: "2026-07-01T00:00:00.000Z",
    },
  },
  query: `
query ($input: AddressCleanserQueryInput) {
  addressCleanserRequests(input: $input) {
    id
    recommendation
    score
    createdAt
  }
}`,
};

GraphQL Query

Variables

Response

Available filter fields on AddressCleanserQueryInput:

Field	Description
recommendation	Filter by recommendation — approve, review, or reject
minCreatedAt	Return only requests created after this timestamp (ISO 8601)
maxCreatedAt	Return only requests created before this timestamp (ISO 8601)