Organization Team

Read and write team information

Organization Team object

Attributes

items

Object
{
  "object": "management.team",
  "projects": [
    {
      "project": {
        "object": "organization.project",
        "status": "active"
      },
      "roles": [
        {
          "role": {
            "object": "management.team.role"
          }
        },
        {
          "role": {
            "object": "management.team.role"
          }
        }
      ]
    },
    {
      "project": {
        "object": "organization.project",
        "status": "active"
      },
      "roles": [
        {
          "role": {
            "object": "management.team.role"
          }
        },
        {
          "role": {
            "object": "management.team.role"
          }
        }
      ]
    }
  ]
}

List organization teams

List all organization teams

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional
GEThttp://api.metorial.com/organization/teams
curl -X GET "https://api.metorial.com/organization/teams" \
  -H "Authorization: Bearer metorial_sk_..."

Get team

Get the information of a specific team

URL Parameters

team_id

String

The unique identifier for the team

GEThttp://api.metorial.com/organization/teams/:team_id
curl -X GET "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Update team

Update the role of an team

URL Parameters

team_id

String

The unique identifier for the team

Request Body

name

StringOptional

description

StringOptional
POSThttp://api.metorial.com/organization/teams/:team_id
curl -X POST "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Create organization team

Create a new organization team

Request Body

name

String

description

StringOptional
POSThttp://api.metorial.com/organization/teams
curl -X POST "https://api.metorial.com/organization/teams" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description"
}'

Set team projects

Set the projects assigned to a team

URL Parameters

team_id

String

The unique identifier for the team

Request Body

project_id

String

team_role_ids

Array of Strings
POSThttp://api.metorial.com/organization/teams/:team_id/projects
curl -X POST "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY/projects" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "project_id": "example_project_id",
  "team_role_ids": [
    "example_item"
  ]
}'

Remove team project

Remove a project from a team

URL Parameters

team_id

String

The unique identifier for the team

project_id

String

The unique identifier for the project

DELETEhttp://api.metorial.com/organization/teams/:team_id/projects/:project_id
curl -X DELETE "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY/projects/pro_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Assign member to team

Assign an organization member to a team

URL Parameters

team_id

String

The unique identifier for the team

Request Body

actor_id

String
POSThttp://api.metorial.com/organization/teams/:team_id/members
curl -X POST "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY/members" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "actor_id": "example_actor_id"
}'

Remove member from team

Remove an organization member from a team

URL Parameters

team_id

String

The unique identifier for the team

actor_id

String

The unique identifier for the actor

DELETEhttp://api.metorial.com/organization/teams/:team_id/members/:actor_id
curl -X DELETE "https://api.metorial.com/organization/teams/tea_Rm4Mnheq2bfEPhBhP7SY/members/act_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."