Get a client org

GET

/v1/workspaces/{workspaceId}/sharees/{shareeId}

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

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

shareeId

required

string

Responses

200

Client org

Media type application/json

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

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

404

Resource not found

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}