getWorkspace

GET

/api/v1/workspaces/{workspaceId}

getWorkspace

curl --request GET \
  --url '<base-url>/api/v1/workspaces/<workspaceId>' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/workspaces/<workspaceId>';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "id": "string",
  "name": "string",
  "personal": true,
  "role": "owner",
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

workspaceId
string
required

Returns

200

The workspace.

JSON

id
string
required
name
string
required
personal
boolean
required
role
owner
or
admin
or
member
required
createdAt
string
required
format: date-time

404

Error.

JSON

error
string
required