PublishQPublishQ

Get workspace

Return one workspace by ID, including its name, color, description, and account count.

GET
/workspaces/{id}

Return one workspace by ID, including its name, color, description, and account count.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

PublishQ API key sent as Authorization: Bearer pq_live_....

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://publishq.com/api/v1/workspaces/4c57ad21-7dc1-4f0b-a8f6-c7b3fdd8c9e7"
{
  "id": "4c57ad21-7dc1-4f0b-a8f6-c7b3fdd8c9e7",
  "name": "Personal Brand",
  "description": "The home base for every story worth telling.",
  "color": "#2563eb",
  "accountCount": 5,
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "title": "Unauthorized",
    "status": 401,
    "code": "missing_auth",
    "message": "Missing Authorization header",
    "instance": "/api/v1/posts"
  }
}

{
  "error": {
    "title": "Forbidden",
    "status": 403,
    "code": "insufficient_scope",
    "message": "Missing required scope: workspaces:read",
    "instance": "/api/v1/workspaces/4c57ad21-7dc1-4f0b-a8f6-c7b3fdd8c9e7"
  }
}
{
  "error": {
    "title": "Not Found",
    "status": 404,
    "code": "workspace_not_found",
    "message": "Workspace not found",
    "instance": "/api/v1/workspaces/4c57ad21-7dc1-4f0b-a8f6-c7b3fdd8c9e7"
  }
}
{
  "error": {
    "title": "Too Many Requests",
    "status": 429,
    "code": "rate_limit_exceeded",
    "message": "Too Many Requests",
    "instance": "/api/v1/workspaces/4c57ad21-7dc1-4f0b-a8f6-c7b3fdd8c9e7",
    "details": {
      "retryAfter": 60
    }
  }
}