FIfieldpulse
Locations

Retrieve locations list

List locations for an object

get/locations

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/locations
  • Auth
    API key in header x-api-key

Query parameters

limitstring

Defaults to 20 items per page, maximum 100 items allowed.

pagestring

Page number. Starts from 1, defaults to 1.

object_typestring

Allowed values: customer, job.

object_idstring

Object ID.

calculate_countstring

Optional. Values: true, false. If true, the response will contain totla_count

filterstring

Array of attribute, operator, and value parts.

asnstring

Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.

sortstring

Array of attribute and order values.

Response

Successful response

errorboolean

false when the request succeeds.

total_countinteger

Total number of records that match the request, across all pages.

responseobject[]

Example response

{
  "total_count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.