readteam

description

Reads a Buzzy Team by its ID

parameters

The X-Auth-Token and X-User-Id are derived from the values authToken and userId returned from the login endpoint and are used in the HTTP header.

{
        "teamID": "<team ID to read>"
}

response

Returns the team data including name, description, organization ID, and other properties.

example

POST /api/readteam 
X-Auth-Token:<insert token here>
X-User-Id:<insert user id here>

{
        "teamID": "<team ID to read>"
}

You should get back:

{
    "status": "success",
    "body": {
        "_id": "<team ID>",
        "name": "<team name>",
        "description": "<team description>",
        "organizationID": "<parent organization ID>",
        "createdAt": "<creation timestamp>",
        "updatedAt": "<last update timestamp>"
    }
}

---