Skip to main content

Get a product

GEThttps://api.fieldtask.example/public/v1/products/{resource_id}
Permission
products:read
Also available as
fieldtask_get_product

Returns one product or service, with its price options, by its ID.

Use the id from List products or from the Location header of a create response. The product must be approved in your organization's catalog; otherwise the response is 404 resource_not_found, the same as for an ID that doesn't exist or a product that has been deleted. Unavailable products (is_available: false) are still returned.

Permissions​

PermissionDependency in the permission map
products:readNo dependencies

The product has the same fields as in List products. See Reading prices for how prices is built, and Choosing a price before adding the product to a job.

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_foundNo approved product with this ID exists in your organization's catalog, it has been deleted, product reads aren't available in this environment, or the URL is wrong.Check the ID with GET /public/v1/products, and check the API origin and 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.