Skip to main content

Get a customer location

GEThttps://api.fieldtask.example/public/v1/customer-locations/{resource_id}
Permissions
customer_locations:read, customers:read

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​

PermissionDependency in the permission map
customer_locations:readDepends on customers:read
customers:readNo dependencies

The location has the same fields as in List customer locations.

Request​

Responses​

OK

Response Headers
    Cache-Control

    Responses must not be cached.

    X-Request-ID

    Server-generated request correlation ID.

Errors​

This endpoint accepts no query parameters.

StatuscodeMeaningWhat to do
400invalid_queryThe query string has an unknown, repeated or invalid parameter.Send only the documented query parameters, each once.
401invalid_tokenThe 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 ….
403api_access_not_enabledFieldTask hasn't enabled API access for this organization, or has disabled it.An owner or admin requests access in Settings → API connections.
403insufficient_scopeThe connection lacks a permission this request needs. error.code is missing_permission.Add the permission named in error.message to the connection.
404resource_not_foundThe 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).
405method_not_allowedThis 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.
429rate_limit_exceededToo many requests in the current minute, or too many concurrent requests, for the organization or connection.Wait for Retry-After seconds, then retry.
429daily_quota_exceededThe 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.
503temporarily_unavailableThe service couldn't complete the request.Retry with exponential backoff. Retry creates with the same key and body.