Skip to content

Share one of this artifact's tables with the workspace (Teams)

POST
/v1/data/{artifactId}/workspace/_share
curl --request POST \
--url https://shareout.site/v1/data/example/workspace/_share \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "table": "example", "as": "example", "access": "read" }'

Owner-only. Exposes one of this artifact’s tables to other artifacts in the same workspace at read or readwrite level. The data stays in this artifact’s store; this only records an opt-in grant.

artifactId
required
string

Artifact ID (e.g. art_abc123).

Media typeapplication/json
object
table
required

Name of this artifact’s table to share.

string
as

Workspace-unique shared name (defaults to the table name).

string
access
string
default: read
Allowed values: read readwrite

Share created or updated

Access denied

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}