/api/public/v1/sharesshares.list
Copies sent from this workspace (newest first, last 200), optionally for one profile, with state and preparation progress.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
profilequery | string (uuid) | No | Only copies of this profile |
Examples
curl "https://browlix.com/api/public/v1/shares" \
-H "Authorization: Bearer $BROWLIX_API_KEY"Response
200 with { data, correlation_id }.
| Field | Type | Always present | Description |
|---|---|---|---|
| data | array<object> | Yes | |
| data[].id | string (uuid) | Yes | |
| data[].state | "preparing" | "available" | "importing" | "delivered" | "declined" | "revoked" | "expired" | "failed" | Yes | |
| data[].profile_name | string | Yes | |
| data[].os | "windows" | "linux" | Yes | |
| data[].source_revision | integer | No | Committed revision the copy is pinned to (absent for configuration-only copies) (min -9007199254740991, max 9007199254740991) |
| data[].categories | array<"cookies" | "local_storage" | "indexed_db" | "service_workers" | "extensions" | "bookmarks" | "history" | "open_tabs" | …> | Yes | Browser data carried beyond the configuration |
| data[].recipient_email | string | Yes | |
| data[].message | string | No | |
| data[].expires_at | string (date-time) | Yes | |
| data[].created_at | string (date-time) | Yes | |
| data[].delivered_at | string (date-time) | No | |
| data[].ended_at | string (date-time) | No | |
| data[].failure | object | No | |
| data[].failure.code | string | Yes | |
| data[].failure.message | string | No | |
| data[].progress | object | No | |
| data[].progress.waiting_for_machine | boolean | Yes | |
| data[].progress.phase | string | No | |
| data[].progress.pct | integer | No | (min -9007199254740991, max 9007199254740991) |
| data[].progress.attempts | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data[].profile_id | string (uuid) | No | Absent once the source profile was deleted |
| data[].created_by_email | string | No | |
| correlation_id | string (uuid) | Yes |
Errors
| Code | HTTP | Retryable |
|---|---|---|
| UNAUTHENTICATED | 401 | No |
| FORBIDDEN | 403 | No |
| RATE_LIMITED | 429 | Yes |
| VALIDATION_FAILED | 422 | No |
| DEPENDENCY_UNAVAILABLE | 503 | Yes |
| UNKNOWN | 500 | No |