Get complete user details by id

Prev Next
Get
/v2/Teams/{userId}
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Path parameters
userId
stringRequired

The ID of the team account

Responses
200

Success

Teams - Success status Response

Here you can verify the user portal role, content role,and group associated by the user.

{
  "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",
    "last_login_at": "2024-06-13T14:30:00Z",
    "portal_role": {
      "role_id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
      "role_name": " Owner"
    },
    "content_roles": [
      {
        "version_access": null,
        "language_access": null,
        "category_access": null,
        "article_access": null,
        "access_scope_level": 3,
        "role_id": "62810dc1-2d21-422e-bdfb-c3daebf91dd3",
        "role_name": "Editor"
      }
    ],
    "associated_groups": [
      {
        "id": "c08e52df-1de9-44e7-8c02-be0e41826c24",
        "title": "MyGroupName",
        "description": "This is my group description.",
        "content_role_infos": null
      }
    ]
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
object | null

Customer API response data

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

last_login_at
string (date-time) | null

Last login date of the user

portal_role
object | null

The name of the portal role

role_id
string | null
role_name
string | null
content_roles
Array of object (ContentRoleSummaryCustomer) | null

The name of content role

object
version_access
object | null
version_name
string | null
version_id
string | null
language_access
object | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
category_access
object | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
article_access
object | null
article_name
string | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
access_scope_level
integer (int32)

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
role_id
string | null
role_name
string | null
associated_groups
Array of object (GroupInfo) | null

THe group associated with the team account

object
id
string | null
title
string | null
description
string | null
content_role_infos
Array of object (ContentRoleInfo) | null
object
version_access_info
object | null
version_name
string | null
version_id
string | null
language_access_info
object | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
category_access_info
object | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
article_access_info
object | null
article_name
string | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
access_scope_level
integer (int32)

This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
guide_access_info
object | null
guide_name
string | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
guide_category_access_info
object | null
category_name
string | null
category_id
string | null
language_id
string | null
language_name
string | null
language_code
string | null
version_name
string | null
version_id
string | null
role_name
string | null
role_id
string | null
group_name
string | null
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

Teams - Invalid User Id

Here the user Id is not valid, go to /v2/Teams/email-exists for finding the user Id. Kindly verify that the IsAnSsoUser is false for Non - SSO user.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The user id does not exist.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.