siteworksBookingAccountSearchByPostcode

Get siteworks booking information for accounts at a given postcode.

Deprecation

The 'siteworksBookingAccountSearchByPostcode' field is deprecated.

Please use getOnSiteJobsAccountsByPostcode instead.

- Marked as deprecated on 2026-07-20.
- Scheduled for removal on or after 2026-10-20.

Arguments

after : String

before : String

first : Int

last : Int

postcode : String!


            required

The postcode to search for.

statuses : [AccountStatusChoices]

Filter the accounts by status.

Returns

SiteworksBookingAccountConnectionTypeConnection

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query SiteworksBookingAccountSearchByPostcode(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $postcode: String!,
  $statuses: [AccountStatusChoices]
) {
  siteworksBookingAccountSearchByPostcode(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    postcode: $postcode,
    statuses: $statuses
  ) {
    edgeCount
    edges {
      ...SiteworksBookingAccountConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "postcode": "find-realize-support-he-red",
  "statuses": "PENDING"
}

{
  "data": {
    "siteworksBookingAccountSearchByPostcode": {
      "edgeCount": 95,
      "edges": [SiteworksBookingAccountConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 60
    }
  }
}