Получить информацию о нескольких пользователях

Получить информацию о пользователях#

Ручка#

POST /user/v1/get_users_info

Полный адрес в сети#

Среда	URL
🧪 Dev	`https://gateway.devterra.ru/admin/user/v1/get_users_info`
🚀 Prod	`https://mobile-api.terraprod.ru/admin/user/v1/get_users_info`

Пример тела запроса#

{
    "filters": {
        "userUUIDs": [
            "123e4567-e89b-12d3-a456-426614174000",
            "..."
        ]
    }
}

Поле	Тип	Описание	Обязательное	Пример
userUUIDs	[]string	Уникальные идентификаторы пользователей	✅	`["8a87d1a5-5bce-4361-a2e6-8b5517c81212", "..."]`

Пример тела ответа#

{
    "data": {
        "8a87d1a5-5bce-4361-a2e6-8b5517c81212": {
            "aboutMe": "string",
            "birthday": "string",
            "contacts": {
                "CONTACT_EMAIL": {
                    "code": 0,
                    "codeExpiredTo": "string",
                    "contact": "string",
                    "createdAt": "string",
                    "isClosed": true,
                    "isVerified": true,
                    "type": 0,
                    "typeName": "string",
                    "updatedAt": "string",
                    "userUUID": "string",
                    "uuid": "string"
                }
            },
            "createdAt": "string",
            "enableNotifications": true,
            "firstName": "string",
            "immediateContacts": {
                "email": "string",
                "entity_id": 0,
                "phone": "string",
                "telegram": "string",
                "telegram_id": 0,
                "utm_campaign": "string",
                "utm_medium": "string",
                "utm_source": "string",
                "utm_type": "string"
            },
            "isBanned": true,
            "lastName": "string",
            "location": {
                "cityID": 0,
                "cityName": "string",
                "countryID": 0,
                "countryName": "string",
                "districtID": 0,
                "districtName": "string"
            },
            "middleName": "string",
            "roles": {
                "ROLE_MENTOR": {
                    "createdAt": "string",
                    "role": 0,
                    "roleName": "string",
                    "userUUID": "string",
                    "uuid": "string"
                }
            },
            "totp": true,
            "totpSecret": "string",
            "updatedAt": "string",
            "userMentorLevel": {
                "canChoose": true,
                "cityID": 0,
                "countryID": 0,
                "districtID": 0,
                "isDefault": true,
                "levelUUID": "string",
                "locale": {
                    "mentorDescription": "string",
                    "mentorName": "string",
                    "studentDescription": "string",
                    "studentName": "string"
                },
                "maxCost": 0,
                "minCost": 0,
                "userUUID": "string"
            },
            "userPhoto": {
                "coordinate": {
                    "height": 0,
                    "width": 0,
                    "x": 0,
                    "y": 0
                },
                "photoURL": "string"
            },
            "uuid": "string",
            "worksheets": {
                "ROLE_MENTOR": {
                    "competencies": [
                        {
                            "description": "string",
                            "locale": "string",
                            "uuid": "string"
                        }
                    ],
                    "employments": [
                        {
                            "description": "string",
                            "locale": "string",
                            "uuid": "string"
                        }
                    ],
                    "goalsForYear": "string",
                    "keyAchievements": "string",
                    "mentorYearsCount": {
                        "description": "string",
                        "yearsCount": 0
                    },
                    "roleID": 0,
                    "salaryLevel": {
                        "id": 0,
                        "locale": "string",
                        "name": "string"
                    },
                    "staffCount": {
                        "id": 0,
                        "locale": "string",
                        "name": "string"
                    },
                    "turnoverLevel": {
                        "id": 0,
                        "locale": "string",
                        "name": "string"
                    },
                    "userUUID": "string",
                    "uuid": "string",
                    "videoCard": "string",
                    "yearsOnBusiness": {
                        "id": 0,
                        "locale": "string",
                        "name": "string"
                    }
                }
            }
        "8a87d1a5-5bce-4361-a2e6-8b5517c81211": null
        }
    }
}

data#

Поле	Тип	Описание	Обязательное	Пример
aboutMe	string	О пользователе	❌	`"..."`
birthday	*time.Time	Дата рождения	❌	`"2024-01-15T09:00:00Z"`
сontacts	object (map)	Карта, где ключ - контакт, а значение - данные о контакте	❌	`см. ниже`
createdAt	*time.Time	Дата создания	❌	`"2024-01-15T09:00:00Z"`
enableNotifications	bool	Включены ли уведомления	❌	`"true"`
first_name	string	Имя пользователя	❌	`"Victor"`
immediateContacts	*object	Прямые контакты пользователя и UTM-метки	❌	`см. ниже`
isBanned	bool	Заблокирован ли	❌	`"false"`
last_name	string	Фамилия пользоватея	❌	`"Petrov"`
location	object	Локация, местонахождение пользователя	❌	`см. ниже`
middle_name	*string	Отчество пользователя	❌	`"Petrovich"`
roles	object (map)	Карта, где ключ - роль, а значение - данные о роли	❌	`см. ниже`
totp	bool	Наличие одноразового пароля	❌	`"false"`
totpSecret	*string	Одноразовый пароль	❌	`"..."`
updatedAt	*time.Time	Дата обновления	❌	`"2024-01-15T09:00:00Z"`
userMentorLevel	*object	Информация о уровне пользователя	❌	`см. ниже`
userPhoto	*object	Объект, со ссылкой на фото пользователя и координаты	❌	`см. ниже`
uuid	string	Уникальный идентификатор пользователя	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
worksheets	object (map)	Карта с анкетами пользователя	❌	`см. ниже`

contacts#

Поле	Тип	Описание	Обязательное	Пример
code	int32	Секретный код	❌	`123456`
codeExpiredTo	*time.Time	Дата истечения срока действия	❌	`"2024-01-15T09:00:00Z"`
contact	string	Контакт (почта, номер телефона и т. п.)	❌	`"..."`
isClosed	bool	Флаг - закрыт ли	❌	`"false"`
isVerified	bool	Флаг - подтверждён ли	❌	`"false"`
type	int32	Тип контакта	❌	`1`
typeName	string	Название типа контакта	❌	`1`
createdAt	*time.Time	Дата создания	❌	`"2024-01-15T09:00:00Z"`
updatedAt	*time.Time	Дата обновления	❌	`"2024-01-15T09:00:00Z"`
userUUID	string	Уникальный идентификатор пользователя	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
uuid	string	Уникальный идентификатор контакта	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`

immediateContacts#

Поле	Тип	Описание	Обязательное	Пример
email	string	Электронная почта	❌	`"..."`
entityID	int64	Идентификатор сущности	❌	`1`
phone	string	Номер телефона	❌	`"..."`
telegram	string	Телеграм-юзернейм	❌	`"..."`
telegram_id	string	Идентификатор телеграма	❌	`"..."`
Utm...	string	UTM-метки	❌	`"..."`

location#

Поле	Тип	Описание	Обязательное	Пример
cityID	*int32	Идентификатор города	❌	`1`
cityName	*string	Название города	❌	`"..."`
countryID	*int32	Идентификатор страны	❌	`1`
countryName	*string	Название страны	❌	`"..."`
districtID	*int32	Идентификатор округа	❌	`1`
districtName	*string	Название округа	❌	`"..."`

roles#

Поле	Тип	Описание	Обязательное	Пример
createdAt	*time.Time	Дата создания	❌	`"2024-01-15T09:00:00Z"`
role	int32	Тип роли	❌	`1`
roleName	string	Название роли	❌	`"..."`
userUUID	string	Уникальный идентификатор пользователя	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
uuid	string	Уникальный идентификатор роли	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`

userMentorLevel#

Поле	Тип	Описание	Обязательное	Пример
canChoose	bool	Флаг - можно ли выбрать	❌	`"false"`
cityID	int32	Идентификатор города	❌	`1`
countryID	int32	Идентификатор страны	❌	`1`
districtID	int32	Идентификатор округа	❌	`1`
isDefault	bool	Флаг - основной ли уровень	❌	`"false"`
levelUUID	string	Уникальный идентификатор уровня	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
locale	object	Локаль пользователя	❌	`см. ниже`
maxCost	int32	Минимальная прибыль	❌	`1000`
minCost	int32	Максимальная прибыль	❌	`10000`
userUUID	string	Уникальный идентификатор пользователя	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`

locale#

Поле	Тип	Описание	Обязательное	Пример
mentorDescription	string	Описание ментора	❌	`"..."`
mentorName	string	Имя ментора	❌	`"..."`
studentDescription	string	Описание студента	❌	`"..."`
studentName	string	Имя студента	❌	`"..."`

userPhoto#

Поле	Тип	Описание	Обязательное	Пример
coordinate	object	Ширина и высота фото	❌	`см. ниже`
photoURL	string	Ссылка на фото	❌	`"..."`

coordinate#

Поле	Тип	Описание	Обязательное	Пример
height	int64	Высота	❌	`256`
width	int64	Ширина	❌	`256`
x	int64	Координаты по оси X	❌	`256`
y	int64	Координаты по оси Y	❌	`256`

worksheets#

Поле	Тип	Описание	Обязательное	Пример
competencies	[]*object	Навык пользователя	❌	`[{...}, {...}]`
employments	[]*object	Ниша пользователя	❌	`[{...}, {...}]`
goalsForYear	*string	Цели на год	❌	`"..."`
keyAchievements	*string	Ключевые достижения	❌	`"..."`
mentorYearsCount	*object	Количество лет в менторстве	❌	`{YearsCount: 10, Description: "..."}`
roleID	int32	Тип роли	❌	`1`
salaryLevel	*object	Уровень заработной платы пользователя	❌	`{Id: 1, Name: "...", Locale: "ru"}`
staffCount	*object	Количество сотрудников	❌	`{Id: 1, Name: "...", Locale: "ru"}`
turnoverLevel	*object	Уровень оборота компании	❌	`{Id: 1, Name: "...", Locale: "ru"}`
userUUID	string	Уникальный идентификатор пользователя	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
uuid	string	Уникальный идентификатор анкеты	❌	`"8a87d1a5-5bce-4361-a2e6-8b5517c81212"`
videoCard	*string	Карточка с видео	❌	`"..."`
yearsOnBusiness	*object	Опыт в бизнесе	❌	`{Id: 1, Name: "...", Locale: "ru"}`

competencies, employments#

Поле	Тип	Описание	Обязательное	Пример
description	string	Описание	❌	`"..."`
locale	string	Локаль (язык)	❌	`"..."`
uuid	string	Уникальный идентификатор навыка (ниши)	❌	`"..."`

mentorYearsCount#

Поле	Тип	Описание	Обязательное	Пример
description	string	Описание	❌	`"..."`
yearsCount	int32	Количество лет	❌	`5`

salaryLevel, staffCount, turnoverLevel, yearsOnBusiness#

Поле	Тип	Описание	Обязательное	Пример
id	int32	Идентификатор	❌	`5`
locale	string	Локаль (язык)	❌	`"..."`
name	string	Название	❌	`"..."`