Get Authorization URL
GET/api/faire/instances/:integrationInstance/authorization-url
Generate the Faire OAuth authorization URL for this integration instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Generates a CSRF state token (format: {app_url}~{workspace}_{instance_id}) and returns the fully-formed Faire authorization URL. The state identifies both the workspace that started the flow and the integration instance being authorized, so the callback resolves them without relying on a browser session.
Path Parameters:
integrationInstance- The ID of the integration instance to authorize
Response field:
authorization_url- URL to redirect the user to. The user must be a Faire brand admin.
Auth: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.