Public Web API: Model of a list of users (Get a list of users)

Methods

GET — Get a list of users
POST — Get a list of users

Resource

{
    "error": "string",
    "result": {
        "result": [
            {
                "__createdAt": "date-time",
                "__createdBy": "uuid",
                "__deletedAt": "date-time",
                "__id": "uuid",
                "__name": "string",
                "__updatedAt": "date-time",
                "__updatedBy": "uuid",
                "additionalData": "string",
                "avatar": [
                    "uuid"
                ],
                "birthDate": "date-time",
                "displayedPosition": "string",
                "email": "string",
                "fullname": {
                    "firstname": "string",
                    "lastname": "string",
                    "middlename": "string"
                },
                "groupIds": [
                    "uuid"
                ],
                "hireDate": "date-time",
                "login": "string",
                "mobilePhone": [
                    {
                        "context": "string",
                        "ext": "string",
                        "tel": "string",
                        "type": "string"
                    }
                ],
                "osIds": [
                    "uuid"
                ],
                "owner": "boolean",
                "timezone": "string",
                "workPhone": [
                    {
                        "context": "string",
                        "ext": "string",
                        "tel": "string",
                        "type": "string"
                    }
                ]
            }
        ],
        "total": "int64"
    },
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
result	object		Optional
result.result[]	array	Found items	Optional
result.result[].__createdAt	date-time	Date the item was created	Optional
result.result[].__createdBy	uuid	Unique ID of the user who created the current item	Optional
result.result[].__deletedAt	date-time	Date the item was deleted	Optional
result.result[].__id	uuid	Unique ID	Optional
result.result[].__name	string	Name	Optional
result.result[].__updatedAt	date-time	Date the data was last changed	Optional
result.result[].__updatedBy	uuid	Unique ID of the user who edited the current item	Optional
result.result[].additionalData	string	Additional data	Optional
result.result[].avatar[]	array of uuid	List of unique IDs of a user’s avatar files	Optional
result.result[].birthDate	date-time	Date of birth	Optional
result.result[].displayedPosition	string	Displayed position	Optional
result.result[].email	string	Email	Optional
result.result[].fullname	object	Information about the full name	Optional
result.result[].fullname.firstname	string	Name	Optional
result.result[].fullname.lastname	string	Last name	Optional
result.result[].fullname.middlename	string	Middle Name	Optional
result.result[].groupIds[]	array of uuid	Unique IDs of groups that the user consists in	Optional
result.result[].hireDate	date-time	Hire date	Optional
result.result[].login	string	Login	Optional
result.result[].mobilePhone[]	array	Information about the phone numbers	Optional
result.result[].mobilePhone[].context	string	Global component, for example, country code or domain (for SIP)	Optional
result.result[].mobilePhone[].ext	string	Extension number	Optional
result.result[].mobilePhone[].tel	string	Local component, used within the country	Optional
result.result[].mobilePhone[].type	string	Phone number type (for example, home or mobile)	Optional
result.result[].osIds[]	array of uuid	Unique IDs of the user’s positions	Optional
result.result[].owner	boolean	Company owner flag	Optional
result.result[].timezone	string	Time zone	Optional
result.result[].workPhone[]	array	Information about the phone numbers	Optional
result.result[].workPhone[].context	string	Global component, for example, country code or domain (for SIP)	Optional
result.result[].workPhone[].ext	string	Extension number	Optional
result.result[].workPhone[].tel	string	Local component, used within the country	Optional
result.result[].workPhone[].type	string	Phone number type (for example, home or mobile)	Optional
result.total	int64	Total number of items	Optional
success	boolean	Successful request flag	Optional