Skip to content
vocapable.Docs

One team and its people

GET
/v1/workspace/teams/{team_id}
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/teams/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
team_id
required
Team Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceTeamDetail
object
team
required
WorkspaceTeamSummary
object
id
required
Id
string
name
required
Name
string
description
required
Any of:
string
department_id
required
Any of:
string
scim_external_id
required
Any of:
string
member_count
required
Member Count
integer
lead_count
required
Lead Count
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
parent_team_id
Any of:
string
depth
Depth
integer
default: 1
department_node_of
Any of:
string
members
required
Members
Array<object>
WorkspaceTeamPerson
object
membership_id
required
Membership Id
string
user_id
required
Any of:
string
name
required
Name
string
email
required
Email
string
is_lead
required
Is Lead
boolean
source
required
Source
string
Allowed values: manual scim import
status
required
Status
string
Allowed values: active suspended
is_primary
Is Primary
boolean
can_manage
required
Can Manage
boolean
Example
{
  "team": {
    "depth": 1
  },
  "members": [
    {
      "source": "manual",
      "status": "active",
      "is_primary": false
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}