List the entities your keys reach
Lists the entities that connected to you, including those that have since disconnected from you, and your own entities (the ones that belong to the Garfield account behind your partner account). Newest first by connected_at (or disconnected_at once disconnected), with your own entities last by name. A test key lists its sandbox entities: one connected entity per partner_user_id you onboarded or asked to connect in test mode, then your own sandbox entity, sandbox. See Sandbox entities.
An entity can receive claims and documents when access is connected or own and verified is true. A connected entity that Garfield has not verified, or has rejected, has verified: false. While verified is false, POST /documents/upload-url, POST /claims and POST /claims/{claim_id}/messages return entity_not_verified for it.
Request
GET/entities
Responses
- 200
- 401
- 403
- 429
- 500
- 503
The entities your keys reach.
Authentication failed. code gives the cause: auth_missing (no Authorization header), auth_invalid_format (the token has no pk_test_ or pk_live_ prefix, or its format is not valid), auth_revoked (Garfield revoked your partner account or rejected your application, or you revoked the key) or auth_bad_secret (the partner id, key id or secret is incorrect, or the prefix does not match the key's mode).
The key is valid but does not have access. code gives the cause: auth_partner_not_approved (Garfield has not approved your partner account yet, so only test keys work), entity_not_owned (the entity is not connected to you and is not your own), partner_disconnected (the entity disconnected from you, so you cannot read or write its claims) or entity_not_verified (Garfield has not verified the business yet, or rejected it, so uploads, claims and messages fail while every read still works).
Too many requests. Each partner can send 120 requests per minute across all endpoints and keys, and only requests with a verified key count. Until Garfield approves a partner, the limit is 30 requests per minute. Requests that fail authentication count separately, 10 per minute for each IP address. Past that, fix the key before you send more requests. For the partner limit, wait the number of seconds in Retry-After, then retry. The API counts requests per minute as they arrive, so treat the limits as approximate.
Response Headers
The number of seconds to wait before you retry.
The maximum requests in each window, for the limit you exceeded.
Only on a 429, where it is 0. The API does not report a running count.
The window length in seconds, always 60. The API does not report how much of the current window is left. Only production sends this header.
A server error. code is internal_error. Retry with exponential backoff.
A dependency is temporarily unavailable. code is service_unavailable, or document_verification_failed when the API could not check an uploaded document in storage. Retry after Retry-After when the response has it, otherwise with exponential backoff.
Response Headers
The number of seconds to wait before you retry.