Sources
Sources endpoints of the bizSupply API.
GET /api/v1/sources
List source connections for the authenticated tenant.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
status | query | no | Filter by connection status. |
provider | query | no | Filter by provider type. |
pageable | query | yes |
Responses
| Status | Description |
|---|---|
200 | Paginated list of source connections |
401 | Authentication required |
POST /api/v1/sources/connect/initiate
Initiate an OAuth connection flow for a source provider.
Returns a CSRF-protected authorization URL. The client must redirect the user's browser to that URL.
Request body
application/json→InitiateConnectionRequest
Responses
| Status | Description |
|---|---|
200 | Authorization URL and state |
400 | Unsupported provider |
401 | Authentication required |
POST /api/v1/sources/connect/manual-upload
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/coverage
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /api/v1/sources/custom
Create a custom (non-OAuth) source connection (OWNER or ADMIN only).
Used for partner plugin integrations authenticating via API keys or other credential types. Credentials are stored securely in vault.
Request body
application/json→CreateCustomSourceRequest
Responses
| Status | Description |
|---|---|
201 | Custom source connection created |
400 | Invalid request body |
403 | Insufficient role |
GET /api/v1/sources/email-forwarding/address
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/email-forwarding/allowlist
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /api/v1/sources/email-forwarding/allowlist
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Authorization | header | no |
Request body
application/json→string(byte)
Responses
| Status | Description |
|---|---|
200 | OK |
PATCH /api/v1/sources/email-forwarding/allowlist/{entryId}
Parameters
| Name | In | Required | Description |
|---|---|---|---|
entryId | path | yes | |
Authorization | header | no |
Request body
application/json→string(byte)
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /api/v1/sources/email-forwarding/allowlist/{entryId}
Parameters
| Name | In | Required | Description |
|---|---|---|---|
entryId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/email-forwarding/audit
Parameters
| Name | In | Required | Description |
|---|---|---|---|
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/providers
List available source providers.
Public endpoint — no authentication required. Returns enabled providers for UI display.
Responses
| Status | Description |
|---|---|
200 | List of enabled source providers |
GET /api/v1/sources/{id}
Get details of a specific source connection.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | Source connection UUID. |
Responses
| Status | Description |
|---|---|
200 | Source connection details |
404 | Connection not found or not in tenant |
DELETE /api/v1/sources/{id}
Disconnect and delete a source connection (OWNER or ADMIN only).
Deletes OAuth credentials from vault and notifies the backend service.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | Source connection UUID. |
Responses
| Status | Description |
|---|---|
204 | Connection deleted |
403 | Insufficient role |
404 | Connection not found |
POST /api/v1/sources/{id}/reconnect
Initiate reauthorization for a source requiring reconnection.
Used when a source enters REQUIRES_REAUTHORIZATION status. Starts a new OAuth flow for the same provider.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | Source connection UUID. |
Responses
| Status | Description |
|---|---|
200 | New authorization URL and state |
400 | Source is not in REQUIRES_REAUTHORIZATION status |
404 | Source connection not found |
PATCH /api/v1/sources/{sourceId}
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Request body
application/json→string(byte)
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/{sourceId}/activity
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/{sourceId}/auto-sync
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
PATCH /api/v1/sources/{sourceId}/auto-sync
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Request body
application/json→string(byte)
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/{sourceId}/coverage
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/{sourceId}/folders
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /api/v1/sources/{sourceId}/state
Parameters
| Name | In | Required | Description |
|---|---|---|---|
sourceId | path | yes | |
Authorization | header | no |
Responses
| Status | Description |
|---|---|
200 | OK |