Gets all team accounts

Prev Next
Get
/v2/Teams

Returns the project's team accounts (portal users) with their portal role and last-login timestamp. Uses skip/take pagination — supply skip = take * (page - 1) to navigate through pages. Use the returned userId field as the input to PUT /v2/teams/{userId}/portal, PUT /v2/teams/{userId}/content, and PUT /v2/teams/{userId}/groups. Safe to retry; idempotent.

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.

Query parameters
skip
integer (int32)

Number of records to skip (offset). Default: 0.

Default0
Example0
take
integer (int32)

Number of records to return per page. Default: 20.

Default20
Example20
Responses
200

Operation succeeded. Inspect the response envelope's success flag and the result/data payload.

Mixed team — owner, editor, draft writer

A typical project team with three accounts: an Owner, an Editor, and a Draft Writer. Use each userId as the input to other Team endpoints.

{
  "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": "2026-05-18T08:22:00Z"
    },
    {
      "user_id": "a7f2c5e1-8d4b-4cba-9f10-2b3c4d5e6f70",
      "first_name": "Anita",
      "last_name": "Rao",
      "email_id": "anita.rao@example.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": "Editor",
      "last_login_at": "2026-05-17T16:05:00Z"
    },
    {
      "user_id": "c8d9e0f1-a2b3-4c4d-e5f6-a7b8c9d0e1f2",
      "first_name": "Marcus",
      "last_name": "Lee",
      "email_id": "marcus.lee@example.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": "Draft Writer",
      "last_login_at": null
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Solo project — owner only

A new project with just the owner account. lastLoginAt is populated; the result array has a single entry.

{
  "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": "2026-05-18T08:22:00Z"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object

Generic Customer API response envelope — a Document360.Core.Messages.Core.CustomerApiBaseResponse with a typed Document360.Core.Messages.Common.CustomerApiResponse1.Result payload. Used when the success-shape is a single strongly-typed value (an entity, list, count, etc.). Always check Document360.Core.Messages.Core.CustomerApiBaseResponse.success before consuming Document360.Core.Messages.Common.CustomerApiResponse1.Result.

result
Array of object (TeamAccountSummaryCustomer) | null

The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is true.

object

Compact V2 team account descriptor — identity, profile picture, portal role, and last-login timestamp. Returned by GET /v2/teams.

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

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

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

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

One non-fatal warning attached to an otherwise-successful response.

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

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

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.

401

Authentication failed — the api_token header is missing, malformed, or has been revoked.

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

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

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

One non-fatal warning attached to an otherwise-successful response.

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

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

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.

429

Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.

Headers
Retry-After
integer
Number of seconds to wait before retrying the request.
X-RateLimit-Limit
integer
The maximum number of requests allowed in the current window.
X-RateLimit-Remaining
integer
The number of requests remaining in the current window.
X-RateLimit-Reset
integer
Unix timestamp (seconds) at which the current rate-limit window resets.
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

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

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

One non-fatal warning attached to an otherwise-successful response.

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

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

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.