Get List User

This API is used to get a list of previously created employees.

Note:

• API used for integration case as Partner.

• API_KEY: <shop_key>

• Partner base_url information

GetAccountUsers

post

Body

Responses

post

HTTPcURLJavaScriptPython

POST /GetAccountUsers HTTP/1.1
Host: $BASE_URL.Shop
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "filter": {
    "extension_number": "text",
    "has_extension": true,
    "name": "text",
    "phone": "text",
    "user_ids": [
      "text"
    ]
  },
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "sort": "text"
  }
}

200

A successful response

{
  "account_users": [
    {
      "account_id": "text",
      "deleted": true,
      "department_id": "text",
      "email": "text",
      "full_name": "text",
      "permissions": [
        "text"
      ],
      "phone": "text",
      "position": "text",
      "roles": [
        "text"
      ],
      "short_name": "text",
      "user_id": "text"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Shop/GetAccountUsers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "filter": {
    "extension_number": "<string>",
    "has_extension": "<boolean>",
    "name": "<string>",
    "phone": "<string>",
    "user_ids": [
      "string",
    ]
  },
  "paging": {
    "after": "<string>",
    "before": "<string>",
    "limit": "<integer>",
    "sort": "<string>"
  }
}'

Response:

{
  "account_users": [
    {
      "account_id": "string",
      "deleted": true,
      "department_id": "string",
      "email": "string",
      "full_name": "string",
      "permissions": [
        "string"
      ],
      "phone": "string",
      "position": "string",
      "roles": [
        "string"
      ],
      "short_name": "string",
      "user_id": "string"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Request body structure:

School name	Data type	Describe
extension_number	string	Extension number
has_extension	boolean	True False
name	string	Employee ID assigned to extension
phone	string	Employee phone number
user_ids	array of int64	Employee ID

Return data attribute structure:

Parameters	Data type	Describe
account_id	string<int64>	Shop owner account ID
deleted	boolean	True False
email	string	Email address
full_name	string	Employee Name
phone	string	Employee phone number
user_id	string	Employee ID