Get workspace by slug

GET/workspaces/slug/{slug}

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

slugstringrequired

Responses

200

Workspace

idstringrequired

namestringrequired

slugstringrequired

keystring | nullrequired

ownerIdstringrequired

defaultTeamIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

slugpath*

Request

curl -X GET 'https://pile.nyc/workspaces/slug/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/slug/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/slug/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "key": "string",
  "ownerId": "string",
  "defaultTeamId": "string",
  "createdAt": "string",
  "updatedAt": "string"
}