Get a customer

GEThttps://api.fieldtask.example/public/v1/customers/{resource_id}

Permission: customers:read
Also available as: fieldtask_get_customer

Returns one customer by its ID.

Use the id from a list, from the Location header of a create response, or from an event. The customer must belong to 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.

Archived customers are returned, with "is_archived": true. A customer deleted in FieldTask returns 404.

Permissions

Permission	Dependency in the permission map
`customers:read`	No dependencies

The customer has the same fields as in List customers. To read the customer's service locations, use List customer locations.

Request

Responses

Response Headers

Cache-Control

Responses must not be cached.

X-Request-ID

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.

Request

curl "$FIELDTASK_API_ORIGIN/public/v1/customers/11111111-1111-4111-8111-111111111111" \
  --header "Authorization: Bearer $FIELDTASK_API_TOKEN"

Response200 OK

Customer with a primary address

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Example Property Services",
    "email": "facilities@example.com",
    "phone_number": "+15555550100",
    "color": "#336699",
    "primary_address": "100 Example Avenue, Springfield",
    "is_archived": false,
    "revision": 2,
    "created_at": "2026-11-03T13:58:20.114Z",
    "updated_at": "2026-11-03T14:01:05.732Z"
  }
}

Example values. IDs and times will differ in your organization.

Try itRequest builder

1. Set the base URL to your API origin with Edit. 2. Paste your token. 3. Fill in parameters or the body. 4. Press Send API Request, or copy the request below and run it yourself. Your token is only kept on this page. Sends are real requests: a create makes a real record.

Loading the request builder…

Get a customer

Permissions​

Request​

Responses​

Errors​

Permissions

Request

Responses

Errors