Retrieve list of teams

GET /api/v1/Teams/get-all

Description

This endpoint is used to get a list of all Teams.

Tags: Teams
URL: /api/v1/Teams/get-all
ApiKey: No API key required
Content-Type: text/plain, application/json, text/json
Query Parameters:

• TenantId: string (uuid), optional, the id of the tenant

• Role: TeamRoles, optional, the role of the team

• SearchText: string, optional, the text to search for

• UserId: string (uuid), optional, the id of the user

• PageNumber: integer (int32), optional, the page number

• PageSize: integer (int32), optional, the page size

• version: string, required

• Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)
  Response:
  Success, returns a RegistrationInviteListPagedResponse.
  Error Codes:

• 400: Bad Request

• 404: Not Found

Example:
JSON

GET /api/v1/Teams/get-all
{
"Message": "Team list found",
"Teams": [
  {
    "Id": "12345678-1234-1234-1234-1234567890ab",
    "Name": "Team A",
    "Members": [
      {
        "Id": "12345678-1234-1234-1234-1234567890cd",
        "Name": "User A"
      },
      {
        "Id": "12345678-1234-1234-1234-1234567890ef",
        "Name": "User B"
      }
    ]
  }
],
"Page": 1,
"PageSize": 10,
"TotalPages": 1,
"TotalCount": 1
}

Plain Text

HTTP/1.1 200 OK
{
"Message": "Team list found",
"Teams": [
  {
    "Id": "12345678-1234-1234-1234-1234567890ab",
    "Name": "Team A",
    "Members": [
      {
        "Id": "12345678-1234-1234-1234-1234567890cd",
        "Name": "User A"
      },
      {
        "Id": "12345678-1234-1234-1234-1234567890ef",
        "Name": "User B"
      }
    ]
  }
],
"Page": 1,
"PageSize": 10,
"TotalPages": 1,
"TotalCount": 1
}

/api/v1/Teams/get-all?TenantId=<uuid>&Role=1&SearchText=<string>&UserId=<uuid>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
TenantId	<uuid>
Role	1
SearchText	<string>
UserId	<uuid>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "id": `<uuid>`,
      "email": `<string>`,
      "role": 3,
      "status": 2,
      "tenantId": `<uuid>`,
      "fullName": `<string>`,
      "userId": `<uuid>`
    },
    {
      "id": `<uuid>`,
      "email": `<string>`,
      "role": 2,
      "status": 3,
      "tenantId": `<uuid>`,
      "fullName": `<string>`,
      "userId": `<uuid>`
    }
  ]
}