Skip to main content

Get terminals​

x-ms-visibility: "important"

Retrieves all terminals

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

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

    search string

    Free text filter for terminal name and external id.

    sortKey string

    Field to be used for sorting. Default: name

    sortDescending boolean

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

Responses

Terminals successfully retrieved.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id string
    name string
    integrationId string
    externalTerminalId string
    customerReference string
    countryCode string
    partyId string
    address string
    city string
    postalCode string
    state string
    country string
    coordinates object
    latitude string
    longitude string
    invoiceBaseUrl uri
    invoiceCreator string nullable

    Possible values: [CPO, PTP]

    Default value: CPO

    locationIds string[]
    chargerIds string[]
    created date-time
    lastUpdated date-time
  • ]
Loading...