Skip to main content

Get a member invitation

GEThttps://api.fieldtask.example/public/v1/member-invitations/{resource_id}
Permissions
members:invite, members:read

Returns one ordinary-member invitation by its ID.

Use the id from a create response (also in its Location header) or from List member invitations. The invitation must belong to the organization your credential is connected to and be for an ordinary member; otherwise the response is 404 resource_not_found, the same as for an ID that doesn't exist.

The most common use is checking whether someone has accepted: status changes from pending to accepted, or to expired once expires_at passes.

Permissions​

PermissionDependency in the permission map
members:inviteDepends on members:read
members:readNo dependencies

Like every invitation endpoint, this one acts on behalf of the connection's invitation sponsor, who must still be an owner or admin. See Invitation authority.

The invitation has the same fields as in List member invitations.

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 URL has a query string. This endpoint accepts none.Remove the query string.
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 members:read or members:invite. error.code is missing_permission.Add the permission named in error.message to the connection in Settings → API connections.
403operation_forbiddenThe connection has no eligible invitation sponsor: the owner or admin it acts for is no longer an owner or admin, or their account is inactive.A current owner or admin edits the connection's permissions in Settings → API connections, which makes them the sponsor. See Invitation authority.
404resource_not_foundNo ordinary-member invitation with this ID exists in your organization (including one cancelled in the FieldTask app), or invitation reads aren't enabled in this environment.Check the ID. Find invitations with GET /public/v1/member-invitations.
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.