Skip to main content

List Location Entries

Returns a list of your Location Entries.

Path Parameters

  • id string required
Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • contact_id object
    • eq string required
    • locatable_id object
    • eq string required
    • locatable_type object
    • eq string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    The number of remaining records including the returned records, up to a maximum of 500.

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • contact_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • 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, Equipment]

    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...