List Teams

GET 
/organizations/:organizationId/teams

List teams for organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of team data objects.
Array [
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
user object[]required
Array [
id stringrequired
email stringrequired
firstName stringrequired
lastName stringrequired
]
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "user": [
        {
          "id": "string",
          "email": "string",
          "firstName": "string",
          "lastName": "string"
        }
      ],
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "6d708f0e-xxxx-xxxx-xxxx-f0d9c59488ef",
      "organizationId": "o-organizationId",
      "name": "IDT-Team",
      "description": "IDT-Team-Description",
      "user": [
        {
          "id": "53abe59e-xxxx-xxxx-xxxx-11aa5d05dd6e",
          "email": "example@infodeck.io",
          "firstName": "Ashton",
          "lastName": "Kevin"
        }
      ],
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...