Get all team accounts
  • 26 Sep 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Get all team accounts

  • Dark
    Light

Article Summary

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.

Default"0"
take
integer (int32)

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

Default"20"
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",
      "portal_role": "Owner",
      "last_login_at": "2023-09-26T06:34:59.6215437Z"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
Array of object (TeamAccountSummaryCustomer)

Customer API response data

object
user_id
string

The ID of the user

first_name
string

First name of the user

last_name
string

Last name of the user

email_id
string

Email address of the user

profile_logo_url
string

Profile image URL of the user

portal_role
string

The name of the portal role

last_login_at
string (date-time)

Last login date of the user

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?