Get a Team Space folder by slug path

GET

/v1/workspaces/{workspaceId}/folders/by-path/{path}

const url = 'https://shareout.site/v1/workspaces/example/folders/by-path/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

path

required

string

Slash-separated folder slugs, e.g. clients/acme.

Responses

200

The folder

application/json

object

string

name

string

slug

string

description

string | null

artifact_count

integer

parent_id

Team Space folders only.

string | null

visibility

Team Space folders only.

string

Allowed values: inherit public workspace private

subfolder_count

Team Space folders only.

integer

path

Slug path; single-folder Team Space responses only.

string

readme

Single-folder Team Space responses only.

string | null

effective_visibility

Single-folder Team Space responses only.

string

created_at

string format: date-time

Example

{
  "visibility": "inherit"
}

404

Resource not found

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