> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectedfleet.michelin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Location

> Returns the location (points of interest) matching the specified parameters.<br/><br/>If no parameters are specified, then all locations are returned.<br/>If there are more than 50 locations, then by default only the first 50 locations are returned.<br/>To view details of the other locations you will need to specify values for pageSize and pageIndex.



## OpenAPI

````yaml /api-reference/fleet-management.json get /public/v1/customer/{customerId}/location/current
openapi: 3.0.1
info:
  title: Fleet management
  description: >-
    A comprehensive administration pack enabling full control over fleet
    structures, users, drivers, vehicles and operational data.
  contact:
    name: Masternaut
    url: https://www.masternaut.com
    email: support@masternautconnect.com
  version: 124.0.2607160821
servers:
  - url: https://api.masternautconnect.com/connect-webservices/services
    description: Product Server
security:
  - basicAuth: []
tags:
  - name: /driver
    description: Driver Operations
  - name: /group
    description: Group operations
  - name: /location/category
    description: Location category management operations
  - name: /location
    description: Location management operations
  - name: /role
    description: Role operations
  - name: /tokenInformation
    description: Token operations
  - name: /user
    description: User operations
  - name: /maintenance
    description: Vehicle maintenance operations
  - name: /vehicle
    description: Vehicle management operations
paths:
  /public/v1/customer/{customerId}/location/current:
    get:
      tags:
        - /location
      summary: List Location
      description: >-
        Returns the location (points of interest) matching the specified
        parameters.<br/><br/>If no parameters are specified, then all locations
        are returned.<br/>If there are more than 50 locations, then by default
        only the first 50 locations are returned.<br/>To view details of the
        other locations you will need to specify values for pageSize and
        pageIndex.
      operationId: getCurrentPlaces
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
        - name: pageIndex
          in: query
          description: >-
            Specifies the pagination page index.<br/>Pages are zero indexed,
            i.e. the first page has an index value of zero.
          required: false
          schema:
            type: integer
            description: >-
              Specifies the pagination page index.<br/>Pages are zero indexed,
              i.e. the first page has an index value of zero.
            format: int32
        - name: pageSize
          in: query
          description: >-
            Specifies the number of items to include on a page.<br/>Must be
            specified if pageIndex has been specified.
          required: false
          schema:
            type: integer
            description: >-
              Specifies the number of items to include on a page.<br/>Must be
              specified if pageIndex has been specified.
            format: int32
        - name: name
          in: query
          description: >-
            Location name search string. This is a case insensitive partial
            match. A location will match if the specified name is found anywhere
            in the location name.
          required: false
          schema:
            type: string
            description: >-
              Location name search string. This is a case insensitive partial
              match. A location will match if the specified name is found
              anywhere in the location name.
        - name: address
          in: query
          description: >-
            Location address search string. This is a case insensitive partial
            match. A location will match if the specified address is found
            anywhere in formatedAddress.
          required: false
          schema:
            type: string
            description: >-
              Location address search string. This is a case insensitive partial
              match. A location will match if the specified address is found
              anywhere in formatedAddress.
        - name: category
          in: query
          description: >-
            A location category name. This is a case sensitive exact match
            search.
          required: false
          schema:
            type: string
            description: >-
              A location category name. This is a case sensitive exact match
              search.
        - name: reference
          in: query
          description: >-
            Location reference search string. This is a case insensitive partial
            match. A location will match if the specified reference is found
            anywhere in reference.
          required: false
          schema:
            type: string
            description: >-
              Location reference search string. This is a case insensitive
              partial match. A location will match if the specified reference is
              found anywhere in reference.
        - name: phoneNumber
          in: query
          description: >-
            Location phone number search string. This is a partial match. A
            location will match if the specified number is found anywhere in
            phoneNumber. Do not include a “+” in the search value.
          required: false
          schema:
            type: string
            description: >-
              Location phone number search string. This is a partial match. A
              location will match if the specified number is found anywhere in
              phoneNumber. Do not include a “+” in the search value.
        - name: contact
          in: query
          description: Contact name search string.
          required: false
          schema:
            type: string
            description: Contact name search string.
      responses:
        '200':
          description: Successful operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: >-
                  #/components/schemas/WithPaginationResultLocationSearchResultDto
components:
  schemas:
    WithPaginationResultLocationSearchResultDto:
      type: object
      properties:
        totalPages:
          type: integer
          description: Total number of pages based on the pageSize.
          format: int32
        totalCount:
          type: integer
          description: Total number of items that matched the search parameters.
          format: int64
        items:
          type: array
          description: Array of items.
          items:
            $ref: '#/components/schemas/LocationSearchResultDto'
    LocationSearchResultDto:
      type: object
      properties:
        id:
          type: string
          description: >-
            Unique, unchangeable system generated identifier (alphanumeric) of
            the location.
        name:
          type: string
          description: Name of the location.
        address:
          $ref: '#/components/schemas/MMAddressDto'
        coordinate:
          $ref: '#/components/schemas/MMCoordinateDto'
        customerId:
          type: string
          description: MCF customer identifier (alphanumeric).
        customerReference:
          type: string
          description: MCF customer reference.
        categoryId:
          type: string
          description: >-
            Unique, unchangeable system generated identifier (alphanumeric) for
            the location category.
        categoryName:
          type: string
          description: The name of the location category.
        radiusKm:
          type: number
          description: Radius in kilometers for circular geofence.
          format: double
        polygon:
          type: array
          description: >-
            Array of points that define the geo-fence boundary of the polygon.
            Only included if the location has a type of POLYGON.
          items:
            $ref: '#/components/schemas/MMCoordinateDto'
        type:
          type: string
          description: >-
            Specifies if the geo-fence boundary for this location has been
            defined as a circle or a polygon; can be POLYGON or CIRCULAR.
        reference:
          type: string
          description: >-
            A reference for this location. Included in the response if a
            reference has been specified for this location.
        phoneNumber:
          type: string
          description: >-
            A phone number for this location. Included in the response if a
            phone number has been specified for this location.
        contact:
          type: string
          description: >-
            A contact for this location. Included in the response if a contact
            has been specified for this location.
        email:
          type: string
          description: >-
            An email address for this location. Included in the response if an
            email address has been specified for this location.
        notes:
          type: string
          description: >-
            The notes for this location. Included in the response if notes have
            been specified for this location.
        circularGeofence:
          $ref: '#/components/schemas/CircularGeofence'
        polygonGeofence:
          $ref: '#/components/schemas/PolygonGeofence'
      description: Array of items.
    MMAddressDto:
      type: object
      properties:
        formattedAddress:
          type: string
          description: Formatted address for the location.
        road:
          type: string
          description: Road name.
        roadNumber:
          type: string
          description: Road number.
        city:
          type: string
          description: City.
        postCode:
          type: string
          description: Postcode.
        country:
          type: string
          description: Country.
        roadType:
          type: string
          description: Road type.
      description: Address object of the location.
    MMCoordinateDto:
      type: object
      properties:
        longitude:
          type: number
          description: Longitude value for the central point of the location.
          format: double
          example: -1.3421
        latitude:
          type: number
          description: Latitude value for the central point of the location.
          format: double
          example: 53.8304
      description: >-
        Array of points that define the geo-fence boundary of the polygon. Only
        included if the location has a type of POLYGON.
    CircularGeofence:
      type: object
      properties:
        centre:
          $ref: '#/components/schemas/Coordinate'
        radiusKm:
          type: number
          format: double
        boundingBox:
          $ref: '#/components/schemas/BoundingBox'
        size:
          type: integer
          format: int64
    PolygonGeofence:
      type: object
      properties:
        polygon:
          type: array
          items:
            $ref: '#/components/schemas/Coordinate'
        size:
          type: integer
          format: int64
        centre:
          $ref: '#/components/schemas/Coordinate'
        boundingBox:
          $ref: '#/components/schemas/BoundingBox'
    Coordinate:
      type: object
      properties:
        longitude:
          type: number
          description: Longitude coordinate in decimal degrees.
          format: double
          example: -1.3421
        latitude:
          type: number
          description: Latitude coordinate in decimal degrees.
          format: double
          example: 53.8304
      description: >-
        Geographic coordinate with latitude and longitude values in decimal
        degrees.
    BoundingBox:
      type: object
      properties:
        topRight:
          $ref: '#/components/schemas/Coordinate'
        bottomLeft:
          $ref: '#/components/schemas/Coordinate'
        size:
          type: integer
          format: int64
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````