klink-developers-logo

User

Listing

GET/api/v1/users

Returns a paginated list of the users in your workspace.

keyword matches on name and email. Search is substring-based, so kyaw finds "Kyaw Kyaw".

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params
  • pageinteger | nulloptional

    Page number. Defaults to 1.

    Example:1

  • pageSizeinteger | nulloptional

    Records per page. Defaults to 10, maximum 200.

    Example:10

  • keywordstring | nulloptional

    Filter by name or email substring.

    Example:

Responses

200

OK

  • pageintegerrequired
  • pageSizeintegerrequired
  • totalintegerrequired
  • lastPageinteger | nullrequired
  • dataarray[object]required
    Child attributes
    • idstringrequired
    • namestringrequired
    • emailstringrequired
    • phonestring | nullrequired
    • addressstring | nullrequired
    • globalAgentCapacityinteger | nullrequired

      Maximum concurrent conversations for this agent, or null to fall back to the queue setting.

    • rolesarray[object]required
      Child attributes
      • idstringrequired

        Role ID. Use this in roleIds when creating or updating a user.

      • systemNamestringrequired
      • displayNamestringrequired
      • descriptionstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
401

Unauthorized

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired