Generate a connect link for an existing Garfield user to approve
POST/connect-requests
Mints a single-use, time-limited connect token and returns a connect_url you send to a business that already has a Garfield account. When the user opens the link and approves it from inside Garfield, their entity is linked to you and you can then create and list claims for it.
The token expires one hour after issue (expires_at). Tokens are single-use: once redeemed they cannot be reused. In test mode the token is deterministic and not redeemable, and expires_at is null.
Request
Responses
- 201
- 400
- 401
- 403
- 429
- 500
- 503
A connect link was created.
The request body was malformed or failed validation. code is one of validation_failed (schema validation; see details), invalid_json (body was not valid JSON), or body_required (no JSON body: sent with a missing body or a Content-Type other than application/json).
Authentication failed. The code distinguishes the cause: auth_missing (no Authorization header), auth_invalid_format (malformed token), auth_unknown_partner (no such partner), auth_revoked (partner or key revoked), auth_bad_secret (bad key id or secret).
The partner is authenticated but not authorised. code is auth_partner_not_approved (the partner account is still pending approval; no endpoint will work until it is approved), entity_not_owned (no connection to the entity), or partner_disconnected (the entity disconnected the partner).
The per-partner rate limit (120 requests per minute, shared across all partner endpoints) was exceeded. Inspect Retry-After and the X-RateLimit-* headers before retrying.
Response Headers
Seconds to wait before retrying.
The request ceiling for the window.
Requests remaining in the current window.
Unix epoch milliseconds when the window resets.
An unexpected server error occurred. The message is always the generic string Internal error; key on code, not message.
A dependency the request relies on is temporarily unavailable. The partner did nothing wrong; retry after the delay in Retry-After.
Response Headers
Seconds to wait before retrying.