MisarMisar Docs
MisarMailMisarBlogMisarReachMisarPostMisarDevMisarCoderMisarSEOMisar PlatformMisar SSO
API Reference

Workspaces API

List and create workspaces and manage their members — api.misar.io/reach/api/workspaces.

Workspaces group teammates and shared MisarReach data. Every operation in this family is rate-limited (api tier).

Base URL: https://api.misar.io/reach/api · Auth: Authorization: Bearer mrk_…

Response bodies on the developer contract are open-form — the examples below show representative fields.

List workspaces

GET/api/workspaces

Returns the workspaces the caller belongs to. Required scope: workspaces:read.

Request
curl https://api.misar.io/reach/api/workspaces \
  -H "Authorization: Bearer mrk_your_key_here"
200 — OK
{ "workspaces": [{ "id": "uuid", "name": "Acme Sales", "role": "owner" }] }

Create a workspace

POST/api/workspaces

Creates a new workspace owned by the caller. Required scope: workspaces:write.

Request body

namestringbodyrequired
Workspace name.
Request
curl -X POST https://api.misar.io/reach/api/workspaces \
  -H "Authorization: Bearer mrk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Sales" }'
201 — Created
{ "ok": true, "workspace": { "id": "uuid", "name": "Acme Sales" } }

List members

GET/api/workspaces/:id/members

Returns the members of a workspace. Required scope: workspaces:read.

Path parameters

idstringpathrequired
Workspace UUID.
Request
curl https://api.misar.io/reach/api/workspaces/WORKSPACE_ID/members \
  -H "Authorization: Bearer mrk_your_key_here"
200 — OK
{ "members": [{ "user_id": "uuid", "email": "teammate@acme.com", "role": "member" }] }

Add / remove a member

POST/api/workspaces/:id/members

Add (POST) or remove (DELETE) a workspace member. Required scope: workspaces:write.

Path parameters

idstringpathrequired
Workspace UUID.

POST body

emailstringbodyrequired
Email of the teammate to invite.
rolestringbody
Member role, e.g. member or admin.
Add member
curl -X POST https://api.misar.io/reach/api/workspaces/WORKSPACE_ID/members \
  -H "Authorization: Bearer mrk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "email": "teammate@acme.com", "role": "member" }'
Remove member
curl -X DELETE https://api.misar.io/reach/api/workspaces/WORKSPACE_ID/members \
  -H "Authorization: Bearer mrk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "user_id": "uuid" }'
200 / 201
{ "ok": true }

Status codes

CodeMeaning
200Workspaces / members returned, member removed
201Workspace created or member added
403Missing workspaces:read / workspaces:write scope
404Workspace not found or caller is not a member
429Rate limit exceeded — retry after Retry-After

See Rate limits and Errors.