Users & Permissions

Get location users

Request

The method allows you to get users of the location.
location User object:

Attribute	Type	Description
id	number	User ID
name	string	User name
phone	string	User phone
email	string	User email
information	string	User information
is_approved	boolean	Whether the user accepted the invitation to manage the location
is_non_deletable	boolean	Whether the user is non-deletable

Security

BearerPartnerUser

Path

location_idnumberrequired

location ID

Query

filter[is_approved]number

Whether the user accepted the invitation to manage the location. 1 - accepted, 0 - not accepted

Example:filter[is_approved]=1

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/company/{location_id}/users?filter%5Bis_approved%5D=1' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Response status.

Example:true

dataArray of objects

Response data.

Example:

[
  {
    "id": 10,
    "name": "Bob",
    "phone": "+13155550184",
    "email": "test@gmail.com",
    "information": "manager",
    "is_approved": false,
    "is_non_deletable": false
  },
  {
    "id": 11,
    "name": "Oliver",
    "phone": "+13155550185",
    "email": "test@gmail.com",
    "information": "Administrator",
    "is_approved": true,
    "is_non_deletable": true
  }
]

metaobject

Additional response data.

Example:

{
  "count": 2
}

Response

{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "count": 2
  }
}