{
  "Title": "Teams",
  "Description": "An organisation may have many teams. Teams may have many channels available. Access to channels may be shared between teams.",
  "Package": "sam",
  "Interface": "Team",
  "Struct": null,
  "Parameters": null,
  "Protocol": "",
  "Authentication": [
    "Client ID",
    "Session ID"
  ],
  "Path": "/teams",
  "APIs": [
    {
      "Name": "list",
      "Method": "GET",
      "Title": "List teams",
      "Path": "/",
      "Parameters": {
        "get": [
          {
            "name": "query",
            "required": false,
            "title": "Search query",
            "type": "string"
          }
        ]
      }
    },
    {
      "Name": "create",
      "Method": "POST",
      "Title": "Update team details",
      "Path": "/",
      "Parameters": {
        "post": [
          {
            "name": "name",
            "required": true,
            "title": "Name of Team",
            "type": "string"
          },
          {
            "name": "members",
            "required": false,
            "title": "Team member IDs",
            "type": "[]uint64"
          }
        ]
      }
    },
    {
      "Name": "edit",
      "Method": "PUT",
      "Title": "Update team details",
      "Path": "/{teamID}",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "name",
            "required": false,
            "title": "Name of Team",
            "type": "string"
          },
          {
            "name": "members",
            "required": false,
            "title": "Team member IDs",
            "type": "[]uint64"
          }
        ]
      }
    },
    {
      "Name": "read",
      "Method": "GET",
      "Title": "Read team details and memberships",
      "Path": "/{teamID}",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "remove",
      "Method": "DELETE",
      "Title": "Remove team",
      "Path": "/{teamID}",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "archive",
      "Method": "POST",
      "Title": "Archive team",
      "Path": "/{teamID}/archive",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "move",
      "Method": "POST",
      "Title": "Move team to different organisation",
      "Path": "/{teamID}/move",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "organisationID",
            "required": true,
            "title": "Team ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "merge",
      "Method": "POST",
      "Title": "Merge one team into another",
      "Path": "/{teamID}/merge",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Source Team ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "destination",
            "required": true,
            "title": "Destination Team ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "memberAdd",
      "Method": "POST",
      "Title": "Add member to a team",
      "Path": "/{teamID}/memberAdd",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Source Team ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "userID",
            "required": true,
            "title": "User ID",
            "type": "uint64"
          }
        ]
      }
    },
    {
      "Name": "memberRemove",
      "Method": "POST",
      "Title": "Remove member from a team",
      "Path": "/{teamID}/memberRemove",
      "Parameters": {
        "path": [
          {
            "name": "teamID",
            "required": true,
            "title": "Source Team ID",
            "type": "uint64"
          }
        ],
        "post": [
          {
            "name": "userID",
            "required": true,
            "title": "User ID",
            "type": "uint64"
          }
        ]
      }
    }
  ]
}