Get a customer location
- Permissions
customer_locations:read,customers:read- Also available as
fieldtask_get_customer_location
Returns one customer location by its ID.
Locations have their own path, /public/v1/customer-locations/{resource_id}, so you don't need the customer's ID to read one. Use the id from List customer locations, from the Location header of a create response, from a job's location_id, or from an event.
The location must belong to a customer in the organization your credential is connected to; otherwise the response is 404 resource_not_found, the same as for an ID that doesn't exist. A location that was deleted, or whose customer was deleted, also returns 404.
Use this endpoint to see coordinates that FieldTask looked up after the location was created. The create response and its replays always show the values from the moment of creation.
Permissions
| Permission | Dependency in the permission map |
|---|---|
customer_locations:read | Depends on customers:read |
customers:read | No dependencies |
The location has the same fields as in List customer locations.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 503
OK
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Bad Request
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Unauthorized
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Forbidden
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Not Found
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Method Not Allowed
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Too Many Requests
Response Headers
Responses must not be cached.
Seconds before retry; present on 429 and an in-progress operation.
Server-generated request correlation ID.
Service Unavailable
Response Headers
Responses must not be cached.
Server-generated request correlation ID.
Errors
This endpoint accepts no query parameters.
| Status | code | Meaning | What to do |
|---|---|---|---|
| 400 | invalid_query | The query string has an unknown, repeated or invalid parameter. | Send only the documented query parameters, each once. |
| 401 | invalid_token | The bearer token is missing, malformed, expired, revoked or issued for a different resource (for example an MCP sign-in). | Send a current REST API token or REST OAuth access token as Authorization: Bearer …. |
| 403 | api_access_not_enabled | FieldTask hasn't enabled API access for this organization, or has disabled it. | An owner or admin requests access in Settings → API connections. |
| 403 | insufficient_scope | The connection lacks a permission this request needs. error.code is missing_permission. | Add the permission named in error.message to the connection. |
| 404 | resource_not_found | The record doesn't exist or isn't visible to this connection, the feature isn't available in this environment, or the URL is wrong. | Check the ID, the API origin and the path (no trailing slash). |
| 405 | method_not_allowed | This path doesn't accept the HTTP method, or the create isn't enabled in this environment. The Allow header lists the methods that are. | Use a method listed in Allow. |
| 429 | rate_limit_exceeded | Too many requests in the current minute, or too many concurrent requests, for the organization or connection. | Wait for Retry-After seconds, then retry. |
| 429 | daily_quota_exceeded | The organization or connection has used its daily allowance for this kind of request. Allowances reset at 00:00 UTC. | Wait for Retry-After seconds, or check remaining allowance in Settings → API connections. |
| 503 | temporarily_unavailable | The service couldn't complete the request. | Retry with exponential backoff. Retry creates with the same key and body. |