Get current user

GET/v2/user/me

Last modified: 3 days ago

Get current user

Request

Query Params

products

boolean

optional

If true, returns the available products for the user

details

boolean

optional

If true, returns the details for the user

current_plan

boolean

optional

If true, returns the current plan for the user

Request samples

Responses

OK(200)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

default response

object {0}

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "type": {
                "type": "string"
              },
              "attributes": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "username": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "locale": {
                    "type": "string"
                  },
                  "timezone": {
                    "type": "string"
                  },
                  "active_product": {
                    "type": "string"
                  },
                  "organization": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  },
                  "created_at": {
                    "type": "string",
                    "format": "date_time"
                  },
                  "updated_at": {
                    "type": "string",
                    "format": "date_time"
                  },
                  "last_sign_in_at": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "date_time",
                    "nullable": true
                  },
                  "last_sign_in_ip": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "nullable": true
                  },
                  "sign_in_count": {
                    "type": [
                      "integer",
                      "null"
                    ],
                    "nullable": true
                  },
                  "two_factor_authentication": {
                    "type": "object",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "otp_sms_enabled": {
                        "type": "boolean"
                      },
                      "otp_totp_enabled": {
                        "type": "boolean"
                      },
                      "otp_phone": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "nullable": true
                      },
                      "otp_default_method": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "nullable": true
                      }
                    }
                  },
                  "incomplete_details": {
                    "type": "boolean",
                    "example": false
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Last modified: 3 days ago