Skip to main content

Get sites​

x-ms-visibility: "important"

Retrieve a list of all sites associated with the user.

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    sortKey string

    Sort field to be used. Default: 'GroupName'

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false'

    country string

    Country to be filtered with.

    city string

    City to be filtered with.

    search string

    Free text filter for site name.

    showOnlyRootSites boolean

    Enable showing only root sites. Default: 'false'

    parentSiteId int64

    Filter sites by parent site ID.

Responses

List of sites accessible by the user.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id int64 nullable
    name string nullable
    publicName string
    isPublicSite boolean nullable
    groupType string
    externalId string
    streetAddress string
    city string
    postalCode string
    country string
    latitude double nullable
    longitude double nullable
    timezone string
    parentSiteId int64 nullable
    payerId int64 nullable
    costId string
    paymentRecipientId int64 nullable
    parkingType string
    parentName string
    numberOfChargers int64 nullable
    numberOfSubsites int64 nullable
    sitePath object[]
  • Array [
    • siteId int64
    siteName string
  • ]
    • tariffReferences object[]
  • Array [
    • groupId string
    tariffId string
    usageType int32 nullable

    Possible values: [0, 1]

    Default value: 0

  • ]
    • metadata string[]
    notes string
  • ]
Loading...