List workspace guidance (context) files

GET

/v1/workspaces/{workspaceId}/context

curl --request GET \
  --url https://shareout.site/v1/workspaces/example/context \
  --header 'Authorization: Bearer <token>'

• Production

Any member. Markdown house rules an agent reads when working in the workspace.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Responses

200

Files (unpaginated, max 100)

Media typeapplication/json

object

entry

File an agent reads first (default index.md).

string

files

Array<object>

object

name

string

size

integer

is_entry

boolean

updated_by

string | null

updated_at

string format: date-time

Example^generated

{
  "entry": "example",
  "files": [
    {
      "name": "example",
      "size": 1,
      "is_entry": true,
      "updated_by": "example",
      "updated_at": "2026-04-15T12:00:00Z"
    }
  ]
}

403

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"
    ]
  }
}