Get all team accounts

  • Updated on Dec 24, 2024
  • 1 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Get
/v2/Teams
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Query parameters
skip
integer (int32)

Specify the number of records to be bypassed and return the remaining results. The default value is 0.

Default0
take
integer (int32)

Specify the number of records to be retrieved. The default value is 20.

Default20
Responses
200

Success

Teams - Success response

Here you can view all type of team account. You can find user Id here.

{
  "result": [
    {
      "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
      "first_name": "Peter",
      "last_name": "Jone",
      "email_id": "peterjone@mail.com",
      "profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
      "portal_role": "Owner",
      "last_login_at": "2024-06-13T14:30:00Z"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
Array of object (TeamAccountSummaryCustomer) | null

Customer API response data

object
user_id
string | null

The ID of the user

first_name
string | null

First name of the user

last_name
string | null

Last name of the user

email_id
string | null

Email address of the user

profile_logo_url
string | null

Profile image URL of the user

portal_role
string | null

The name of the portal role

last_login_at
string (date-time) | null

Last login date of the user

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information