Skip to content

Get Sites

Get a list (or subset) of Sites belonging to an Organization.

Verb POST
Endpoint {base-url}/sites
Max Page Size 1000

Request Body

{
  "requestFilter": {
    "organizationIds": [3],
    "accountIds": [49, 3],
    "siteIds": [205]
  }
}

Filters Honored

  • RequestFilter
    • organizationIds
    • accountIds
    • siteIds
    • includeDeleted

Returns

On Success

The requested set of sites.

Response Body

[
  {
    "id": 1782,
    "accountId": 1166,
    "orgId": 317,
    "name": "Bob's Grain Mill",
    "contact": {
        "firstName": "Jane",
        "lastName": "Smith",
        "telephoneNumber": "206-555-0142",
        "emailAddress": "jane.smith@grainmill.com"
    },
    "commissionPercentage": 0.15,
    "isActive": true,
    "timeZone": "Pacific Standard Time",
    "isEnabled": true,
    "maxChargePrice": 5.00,
    "billingAddress": "123 Main Street, Seattle, WA 98101",
    "shippingAddress": "123 Main Street, Seattle, WA 98101",
    "maximumMeterSalesJumpAllowed": 500.0000,
    "commissionTerms": "net10",
    "externalAccountTerminalId": "EXT-00472",
    "chargeKeyId": 1
}
]