Skip to main content

List Location Entries

Returns a list of your Location Entries.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • date date-time

    The date and time at which this Location Entry was recorded.

  • vehicle_id integer

    Possible values: >= 1

  • item_type string

    Possible values: [Vehicle, Contact]

    The type of object that this Location Entry is associated with.

  • item_id NullableId

    Possible values: >= 1

  • locatable_type string

    Possible values: [FuelEntry, ServiceEntry, SubmittedInspectionForm]

    The type of object that triggered the creation of this Location Entry, if applicable.

  • locatable_id NullableId

    Possible values: >= 1

  • contact_id NullableId

    Possible values: >= 1

  • address string

    The full address where this Location Entry took place.

  • address_components object
  • street_number string

    The street number in the address.

  • street string

    The street name in the address.

  • city string

    The city in the address.

  • region string

    The region, state or province in the address.

  • region_short string

    The abbreviated region, state or province code.

  • country string

    The country in the address.

  • country_short string

    The abbreviated country code.

  • postal_code string

    The postal code, ZIP, or equivalent in the address.

  • is_current boolean

    Indicates whether this Location Entry is the most recent one for this object.

  • location string

    A string representation of the recorded location.

  • geolocation object

    The coordinates of the recorded location.

  • latitude Coordinate

    Possible values: >= -90 and <= 90

  • longitude Coordinate

    Possible values: >= -90 and <= 90

Loading...