Fetch workspaces

GET

/workspaces

Fetch workspaces in an organization

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.postly.ai/v2/workspaces' \
--header 'X-API-KEY;'

Response Example

200 - Example 1

{
    "code": "string",
    "message": "string",
    "data": [
        {
            "name": "string",
            "_id": "string",
            "avatar": "string"
        }
    ]
}

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Responses

🟢200Success

application/json

Body

code

string

required

200

message

string

required

Organization workspaces retrieved successfully

data

array[object (Workspace) {3}]

required

Workspace details

name

string

required

Name of workspace

_id

string

required

24-character hexadecimal workspace identifier

avatar

string

required

Workspace logo

🟠400BadRequestResponse

🟠401UnAuthorizedResponse

Modified at 2025-05-30 16:45:49

Overview

Fetch social accounts