Skip to content
Capturit Backend Docs

Authenticated Account

Defines the structure of the account resource.

Utilized By:

Schema

{
    "user": {
        "id": 0,
        "user_first_name": "string",
        "user_middle_name": "string",
        "user_last_name": "string",
        "user_username": "string",
        "user_email": "string",
        "user_avatar_url": "string",
        "user_visible": true,
        "user_status": 0,
        "user_timezone": "string",
        "subscription_plan": {
            "subscription_plan_title": "string",
            "subscription_plan_pricing": 0,
            "subscription_plan_expiration": "2024-12-02T11:58:54.523Z"
        },
        "user_login_options": [
            {
            "user_id": 0,
            "user_login_option_type": 0,
            "user_login_option_unique_identifier": "string",
            "user_login_option_name": "string"
            }
        ],
        "user_settings": {
            "user_setting_mute_notification": true
        },
        "created_at": "2024-12-02T11:58:54.523Z",
        "updated_at": "2024-12-02T11:58:54.523Z"
    },
    "token": "string",
    "token_expiration": "2024-12-04T12:46:45.770Z"
}

Properties

id

Description: Unique identifier of user table
Data Type: integer Nullable: No
Table: User

user_first_name

Description: The user’s first name Data Type: String
Nullable: Yes
Table: User

user_middle_name

Description: The user’s middle name
Data Type: String
Nullable: No
Table: User

user_last_name

Description: The user’s last name
Data Type: String
Nullable: No
Table: User

user_username

Description: The user’s username
Data Type: String
Nullable: Yes
Table: User

user_email

Description: The user’s email
Data Type: String
Nullable: No
Table: User

user_avatar_url

Description: The user’s avatar url
Data Type: String
Nullable: No
Table: User

user_visible

Description: The user’s account is publicly visible
Data Type: boolean
Nullable: No
Table: User

user_status

Description: The user’s account status
Data Type: integer
Nullable: No
Table: User
Value:

  • 1 - Active

user_timezone

Description: The user’s timezone
Data Type: integer
Nullable: No
Table: User

subscription_plan

Description: The user’s subscription plan
Data Type: Object
Nullable: No
Resource: Subscription Plan

user_login_options

Description: The user’s login options
Data Type: Array
Nullable: No
Resource: Login Option

user_settings

Description: The user’s settings
Data Type: Object
Nullable: No
Resource: User Settings

created_at

Description: The timestamp when the record is created
Data Type: Timestamp
Nullable: Yes

updated_at

Description: The timestamp when the record is updated
Data Type: Timestamp
Nullable: Yes

token

Description: The generated token used for authentication and authorization
Data Type: String
Nullable: No

token_expiration

Description: The expiration of the authorization token
Data Type: String
Nullable: No