USER

Gets the list of active users.

GET/api/v2/user/list

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Responses

Users retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

An array. Each item is a UserDto:

userIdinteger · int32
fullNamestring
firstNamestring
lastNamestring
emailstring
departmentstring
titlestring
phonestring
cellstring
faxstring
defaultCountrystring
defaultLanguagestring
timeZonestring
defaultSearchTypestring
recordAccessTypestring
userAccessTypestring
roleIdsinteger[]
roleIdsListstring[]
defaultRoleIdinteger · int32
defaultRolestring
roleDisplaystring
branchIdsinteger[]
branchIdsListstring[]
defaultBranchIdinteger · int32
defaultBranchstring
branchDisplaystring
assignedRightsinteger[]
assignedRightsListstring[]
activeboolean
taskAlertEnabledboolean
taskAlertDaysinteger · int32
salesCodeDisplaystring
typeIdinteger · int32
userTypestring

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/user/list' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": [
    {
      "userId": 1024,
      "fullName": "Jane Doe",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "department": "string",
      "title": "string",
      "phone": "555-0100",
      "cell": "555-0100",
      "fax": "555-0100",
      "defaultCountry": "string",
      "defaultLanguage": "string",
      "timeZone": "string",
      "defaultSearchType": "string",
      "recordAccessType": "string",
      "userAccessType": "string",
      "roleIds": [
        1024
      ],
      "roleIdsList": [
        "string"
      ],
      "defaultRoleId": 1024,
      "defaultRole": "string",
      "roleDisplay": "string",
      "branchIds": [
        1024
      ],
      "branchIdsList": [
        "string"
      ],
      "defaultBranchId": 1024,
      "defaultBranch": "string",
      "branchDisplay": "string",
      "assignedRights": [
        1
      ],
      "assignedRightsList": [
        "string"
      ],
      "active": true,
      "taskAlertEnabled": true,
      "taskAlertDays": 1,
      "salesCodes": [
        {
          "assignedId": 1024,
          "userId": 1024,
          "salesCode": "string"
        }
      ],
      "salesCodeDisplay": "string",
      "typeId": 1024,
      "userType": "string",
      "locations": [
        {
          "locationId": 1024,
          "location": "string",
          "address1": "100 Main St",
          "address2": "100 Main St",
          "city": "Chicago",
          "state": "IL",
          "zip": "60601",
          "county": "Cook",
          "country": "US",
          "mailMerge": true,
          "latitude": 41.8781,
          "longitude": -87.6298
        }
      ]
    }
  ],
  "errors": []
}