title = “Get Saved Locations” description = “Returns a paginated list of active locations. “ weight = 4 pre = ““ +++
Returns a paginated list of active locations.
URLs
| Environment | Method | URL |
|---|---|---|
| Sandbox | https://api-sandbox.fndev.net/api/rest/v2/locations | |
| Production | https://api.fieldnation.com/api/rest/v2/locations |
Path Parameters
Not applicable.
Query Parameters
Refer to Pagination for a list of additional query parameters.
| Parameter | Type | Example | Notes |
|---|---|---|---|
| access_token | string | abc123defg459hijk786lmn45 | Required. |
Body Parameters
Not applicable.
Response
Returns the Saved Location Response by Company. Refer to Saved Locations for parameter details and examples.
Note: This response does not include location attributes or location contact information. Refer to Get Location by ID to return detailed information.
Examples
In the examples below, the Response has been trimmed to display only the results.
"results":[
{
"id":16267,
"location_id":"16267",
"client_id":"188",
"client_name":"Main Street Shipping",
"name":"Default",
"group_id":"0",
"group_name":"",
"type":"Commercial",
"type_id":"1",
"notes":[
{
"id":0,
"text":"",
"private":0
}
],
"address1":"123 Main Street",
"address2":"Building 4C",
"city":"Phoenix",
"state":"AZ",
"zip":"85001",
"country":"US",
"workorders":"12",
"providers":"0",
"status":"1"
}
]