Get User by Location

GET 
/users/

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

application/json

Successful response

application/json

Schema

Schema

usersobject[]

Example (auto)

{
  "users": [
    {
      "id": "0IHuJvc2ofPAAA8GzTRi",
      "name": "John Deo",
      "firstName": "John",
      "lastName": "Deo",
      "email": "[email protected]",
      "phone": "+1 808-868-8888",
      "extension": "",
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true
      },
      "scopes": [
        "contacts.write",
        "campaigns.readonly"
      ],
      "roles": {
        "type": "account",
        "role": "admin",
        "locationIds": [
          "ve9EPM428h8vShlRW1KT"
        ]
      },
      "deleted": false,
      "lcPhone": {
        "locationId": "+1234556677"
      },
      "platformLanguage": "en_US"
    }
  ]
}