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

GET

https://api.easyx.ru/v2/user/profiles

Описание

Запрос вернет информацию о профилях пользователя. В зависимости от прав ответ сервера может отличаться.

Запрос требует право profile.

---

Авторизация

Required

Authorization

Header

Bearer: token

Ответ

200

Успешный запрос

Required

id

UInt

Идентификатор пользователя.

Required

username

String

Логин.

Required

created_at

ISO8601 DateTime

Дата создания профиля (UTC).

email

String

Электронная почта.
Возвращается, если токен выдан с правом email.

first_name

String

Имя.
Возвращается, если токен выдан с правом account.

middle_name

String

Отчество.
Возвращается, если токен выдан с правом account.

last_name

String

Фамилия.
Возвращается, если токен выдан с правом account.

gender

Enum

Пол. Принимает значения: MALE, FEMALE.
Возвращается, если токен выдан с правом account.

birthdate

Date

Дата рождения в формате YYYY-MM-DD.
Возвращается, если токен выдан с правом account.

avatar_url

String

Ссылка на аватар.
Возвращается, если токен выдан с правом avatar.

401

Требуется авторизация

Required

error

Required

code

String

Код ошибки

Required

message

String

Текстовое описание ошибки

403

Недостаточно прав

Required

error

Required

code

String

Код ошибки

Required

message

String

Текстовое описание ошибки

Пример запроса

Payload

cURL

PHP

Content Type

application/json

{}

curl --location 'https://api.easyx.ru/v2/user/profiles' \
--header 'Authorization: Bearer <TOKEN>'

curl

GuzzleHttp

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.easyx.ru/v2/user/profiles',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        sprintf('Authorization: Bearer %s', $token)
    ]
]);

$response = curl_exec($curl);

curl_close($curl);

<?php

use GuzzleHttp\Client;

$client = new Client;

$request = $client->get('https://api.easyx.ru/v2/user/profiles', [
    'headers' => [
        'Authorization' => sprintf('Bearer %s', $token)
    ]
]);

$response = $request->getBody()->getContents();

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

200

401

403

Content Type

application/json

[
    {
        "id": 1,
        "username": "easyid_user",
        "avatar": "https://avatars.easyxcdn.net/35/6a/356a192b7913b04c54574d18c28d46e6395428ab",
        "first_name": "Иван",
        "middle_name": "Иванович",
        "last_name": "Иванов",
        "email": "ivan@easyx.ru",
        "gender": "MALE",
        "birthdate": "01.01.2000",
        "country": "Russia",
        "state": "Moscow",
        "city": "Moscow",
        "phone": "+7XXXXXXXXXX",
        "timezone": "Europe/Moscow",
        "created_at": "2020-12-16T23:45:45.000000Z"
    },
    {
        "id": 2,
        "username": "easyid_user2",
        "avatar": "https://avatars.easyxcdn.net/35/6a/356a192b7913b04c54574d18c28d46e6395428ab",
        "first_name": "Иван",
        "middle_name": "Иванович",
        "last_name": "Иванов",
        "email": "ivan@easyx.ru",
        "gender": "MALE",
        "birthdate": "01.01.2000",
        "country": "Russia",
        "state": "Moscow",
        "city": "Moscow",
        "phone": "+7XXXXXXXXXX",
        "timezone": "Europe/Moscow",
        "created_at": "2020-12-16T23:45:45.000000Z"
    }
]

{
    "error": {
        "code": "UNAUTHORIZED",
        "message": "Authorization required"
    }
}

{
    "error": {
        "code": "INSUFFICIENT_SCOPE",
        "message": "The access token has insufficient scope. Required scope: `profiles`"
    }
}