Authenticated user

Developing

GET

/api/user/auth

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/auth?api_key=agdPPEmXTp3Fz9btGfah8T5dNo5k0CvN7CdOLmKHjUCYL0ofBLZWxWKUkYTa' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

{
    "user": {
        "id": 0,
        "staff_id": "string",
        "parent_id": null,
        "lft": 0,
        "rgt": 0,
        "depth": 0,
        "name": "string",
        "email": "string",
        "phone": "string",
        "gender": null,
        "address": null,
        "postal_code": null,
        "city": null,
        "province": null,
        "email_verified_at": null,
        "role": 0,
        "api_token": null,
        "api_key": "string",
        "api_key_last_used_at": "string",
        "language": "string",
        "created_at": "string",
        "updated_at": "string",
        "ticketit_admin": 0,
        "ticketit_agent": 0,
        "payroll_checkmark": true,
        "pay_plan_id": null,
        "position_id": null,
        "schedule_id": null,
        "deleted_at": null,
        "theme": "string",
        "organization_id": null,
        "salutation": "string",
        "is_agent": 0,
        "reseller_type": null,
        "created_by_script": 0,
        "enable_ssh_access": 0,
        "ssh_username": "string",
        "ssh_password": "string",
        "is_admin": true,
        "role_name": null,
        "padded_name": "string",
        "parent_name": "string",
        "is_deletable": true,
        "is_reseller": true,
        "is_user": true,
        "is_owner": true,
        "role_names": "string",
        "devices": [
            null
        ],
        "parent": null,
        "roles": [
            {
                "id": 0,
                "name": "string",
                "display_name": "string",
                "description": "string",
                "created_at": "string",
                "updated_at": "string",
                "pivot": {
                    "user_id": 0,
                    "role_id": 0,
                    "user_type": "string"
                }
            }
        ]
    },
    "message": "string"
}

Modified at 2026-03-24 15:35:16

Generate API Key

Get Contacts