List client orgs

GET

/v1/workspaces/{workspaceId}/sharees

curl --request GET \
  --url https://shareout.site/v1/workspaces/example/sharees \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Responses

200

Client orgs

Media type application/json

object

sharees

Array<object>

object

id

string

name

string

type

Client, supplier, partner, investor, or any label.

string

member_count

integer

branding

object

logo

string

color

string

Example ^generated

{
  "sharees": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "member_count": 1,
      "branding": {
        "logo": "example",
        "color": "example"
      }
    }
  ]
}

403

Access denied

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}