Skip to content

Request access to a private page

POST
/v1/access-requests
curl --request POST \
--url https://shareout.site/v1/access-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "slug": "example" }'

Signed-in user asks the artifact owner for viewer access (Google Drive style). Requires an email identity. Idempotent while a pending request exists.

Media type application/json
object
slug
required

Production slug of the private artifact.

string
Example generated
{
"slug": "example"
}

Request created or already pending

Media type application/json
object
ok
boolean
status
string
Allowed values: created pending
message
string
Example
{
"status": "created"
}

Invalid request

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example
{
"success": false
}

Resource not found

Media type application/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
Example
{
"success": false
}