List User's Teams

Print
Dark
Light
PDF

List User's Teams

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/users.listTeams

Header parameters

X-Auth-Token

stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f

X-User-Id

stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ

Query parameters

userId

stringRequired

The userId of the user.

ExamplerbAXPnMktTFbNpwtJ

Responses

200

Success Example

{
  "teams": [
    {
      "_id": "612b8ae982d286c3",
      "name": "documentation-team",
      "type": 0,
      "createdAt": "2021-08-29T13:26:01.750Z",
      "createdBy": {
        "_id": "JxemcN9PDCdfzJe",
        "username": "renato.b"
      },
      "_updatedAt": "2021-08-29T13:26:01.762Z",
      "roomId": "GwktYAajqw4RiWiBK",
      "isOwner": true
    }
  ],
  "success": true
}

Expand All

object

teams

Array of object

object

_id

string

name

string

type

integer

createdAt

string

createdBy

object

_id

string

username

string

_updatedAt

string

roomId

string

isOwner

boolean

success

boolean

400

Bad Request

Example 1

{
  "success": false,
  "error": "must have required property 'userId' [invalid-params]",
  "errorType": "invalid-params"
}

object

success

boolean

error

string

errorType

string

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?

What's Next

Report User