Perfil do Usuário Autenticado

Descrição

Retorna os dados do perfil do usuário autenticado, incluindo informações pessoais, porcentagem de preenchimento do perfil, organizações em que ele é proprietário, grupos vinculados a essas organizações e a role atual.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/profile

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Sucesso - 200

{
  "success": true,
  "message": "Profile loaded successfully.",
  "data": {
    "user_id": 1,
    "first_name": "John",
    "middle_name": "Michael",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone_number": "11999999999",
    "language": "en-US",
    "country": "USA",
    "state": "CA",
    "city": "San Francisco",
    "address": "123 Market Street",
    "postal_code": "94103",
    "sms_notification": "1",
    "avatarUrl": "https://api.soargi.com/public/images/profile/avatar-john.jpg",
    "created_at": "2025-04-23T12:00:00Z",
    "updated_at": "2025-04-24T08:00:00Z",
    "completion_percentage": 100
  },
  "role": {
    "role_id": 3,
    "role_name": "Individual"
  },
  "organisations": [
    {
      "org_id": 1,
      "org_name": "OneFactory"
    },
    {
      "org_id": 2,
      "org_name": "DoeTech Inc."
    }
  ],
  "groups": [
    {
      "group_id": 5,
      "group_name": "Developers",
      "org_id": 1,
      "org_name": "OneFactory",
      "total_members": 12
    },
    {
      "group_id": 7,
      "group_name": "Leadership",
      "org_id": 2,
      "org_name": "DoeTech Inc.",
      "total_members": 4
    }
  ]
}

Erro - 401 (Token inválido ou expirado)

{
  "status": 401,
  "error": "Invalid or expired token."
}

Erro - 404 (Usuário não encontrado)

{
  "status": 404,
  "error": "User not found."
}

Códigos de Resposta

  • 200 - Perfil retornado com sucesso
  • 401 - Token inválido ou expirado
  • 404 - Usuário não encontrado