List Faire Instances

GET 
/api/faire/instances

List all Faire integration instances for this account.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Response: Returns a collection of Faire integration instances. Each instance includes:

• id - Internal instance ID
• name - Display name for the instance
• is_active - Whether the instance is active
• fulfillment_mode - Fulfillment mode: fbm (fulfilled by merchant) or fbf (fulfilled by Faire)
• order_import_start_date - Date from which orders are imported
• warehouse_id - Linked internal warehouse ID
• last_orders_sync - ISO timestamp of last order sync
• last_products_sync - ISO timestamp of last product sync
• created_at / updated_at - ISO timestamps

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.