API reference / Account

Get Authenticated User

MD View as MarkdownPlain text version of this page

Open in ClaudeAsk questions about this page Open in ChatGPTAsk questions about this page

GET /api/user

Returns the account the token acts as, serialized as a User resource. Available to any authenticated token regardless of its abilities. Internal columns (such as the integer location_id foreign key) are never exposed; location_id is surfaced as the location's UUID.

Responses

- data User
  - id string (uuid)
  - first_name string
  - last_name string
  - email string (email)
  - perspective Perspective
    
    admin franchisor franchisee
  - location_id string (uuid) nullable
    
    Direct location UUID; null when the user has group-based access.
  - has_sso_auth boolean
  - roles array of string
  - created_at string (date-time) nullable
  - updated_at string (date-time) nullable
  - locationGroups array of LocationGroup
    
    Present only when included (and on the Sync Location Groups response).
    
    id string (uuid)
    
    name string
    
    external_id string nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    locations array of Location
    
    Present only when included.
    
    id string (uuid)
    
    external_id string nullable
    
    name string
    
    address string nullable
    
    city string nullable
    
    region string nullable
    
    postal_code string nullable
    
    country string nullable
    
    timezone string nullable
    
    is_private boolean
    
    is_corporate boolean
    
    is_active boolean
    
    district_id string (uuid) nullable
    
    district_id_2 string (uuid) nullable
    
    location_category_id string (uuid) nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    datasource_settings object
    
    POS identifiers for the location. Credentials are never returned: each one is reported only as {key}_set, true when a value is stored.
    
    district object nullable
    
    Present only when included.
    
    district2 object nullable
    
    Present only when included.
    
    locationCategory object nullable
    
    Present only when included.
    
    locationGroups array of any
    
    Present only when included (and on the Sync Location Groups response).
  - location object nullable
    
    Present only when include=location is requested.
    
    id string (uuid)
    
    external_id string nullable
    
    name string
    
    address string nullable
    
    city string nullable
    
    region string nullable
    
    postal_code string nullable
    
    country string nullable
    
    timezone string nullable
    
    is_private boolean
    
    is_corporate boolean
    
    is_active boolean
    
    district_id string (uuid) nullable
    
    district_id_2 string (uuid) nullable
    
    location_category_id string (uuid) nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    datasource_settings object
    
    POS identifiers for the location. Credentials are never returned: each one is reported only as {key}_set, true when a value is stored.
    
    qu object
    
    brink object
    
    district object nullable
    
    Present only when included.
    
    id string (uuid)
    
    name string
    
    external_id string nullable
    
    district_group_id string (uuid) nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    districtGroup object nullable
    
    Present only when included.
    
    district2 object nullable
    
    Present only when included.
    
    id string (uuid)
    
    name string
    
    external_id string nullable
    
    district_group_id string (uuid) nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    districtGroup object nullable
    
    Present only when included.
    
    locationCategory object nullable
    
    Present only when included.
    
    id string (uuid)
    
    name string
    
    external_id string nullable
    
    location_category_group_id string (uuid) nullable
    
    sort_order integer nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    locationCategoryGroup object nullable
    
    Present only when included.
    
    locationGroups array of LocationGroup
    
    Present only when included (and on the Sync Location Groups response).
    
    id string (uuid)
    
    name string
    
    external_id string nullable
    
    created_at string (date-time) nullable
    
    updated_at string (date-time) nullable
    
    locations array of Location
    
    Present only when included.
- message string

curl "https://app.franchisesee.com/api/user" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json"

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('FRANCHISESEE_TOKEN'))
    ->acceptJson()
    ->get('https://app.franchisesee.com/api/user');

const response = await fetch('https://app.franchisesee.com/api/user', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.FRANCHISESEE_TOKEN}`,
    Accept: 'application/json',
  },
});

const data = await response.json();

import os
import requests

response = requests.request(
    "GET",
    "https://app.franchisesee.com/api/user",
    headers={"Authorization": f"Bearer {os.environ['FRANCHISESEE_TOKEN']}", "Accept": "application/json"},
)

data = response.json()

Response

{
    "data": {
        "id": "6e2b9d41-8c7a-4f3e-b1d5-9a0c2e4f6b81",
        "first_name": "Jordan",
        "last_name": "Rivera",
        "email": "jordan.rivera@example.com",
        "perspective": "admin",
        "location_id": "9b1c8f3e-7a2d-4c5b-8e1a-2f3d4c5b6a7e",
        "has_sso_auth": true,
        "roles": [
            "string"
        ],
        "created_at": "2025-03-14T15:22:08.000000Z",
        "updated_at": "2026-10-02T09:41:55.000000Z",
        "locationGroups": [
            {
                "id": "a3c5e7f9-2b4d-4f6a-8c1e-3d5f7a9b1c20",
                "name": "Austin Metro",
                "external_id": "AUS-METRO",
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z",
                "locations": [
                    {
                        "id": "9b1c8f3e-7a2d-4c5b-8e1a-2f3d4c5b6a7e",
                        "external_id": "STR-1042",
                        "name": "Downtown Austin",
                        "address": "401 Congress Ave",
                        "city": "Austin",
                        "region": "TX",
                        "postal_code": "78701",
                        "country": "US",
                        "timezone": "America/Chicago",
                        "is_private": false,
                        "is_corporate": false,
                        "is_active": true,
                        "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
                        "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
                        "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
                        "created_at": "2025-03-14T15:22:08.000000Z",
                        "updated_at": "2026-10-02T09:41:55.000000Z",
                        "datasource_settings": {
                            "qu": {
                                "location_id": 12345
                            },
                            "brink": {
                                "api_key_set": true
                            }
                        },
                        "district": {},
                        "district2": {},
                        "locationCategory": {},
                        "locationGroups": []
                    }
                ]
            }
        ],
        "location": {
            "id": "9b1c8f3e-7a2d-4c5b-8e1a-2f3d4c5b6a7e",
            "external_id": "STR-1042",
            "name": "Downtown Austin",
            "address": "401 Congress Ave",
            "city": "Austin",
            "region": "TX",
            "postal_code": "78701",
            "country": "US",
            "timezone": "America/Chicago",
            "is_private": false,
            "is_corporate": false,
            "is_active": true,
            "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
            "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
            "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "datasource_settings": {
                "qu": {
                    "location_id": 12345
                },
                "brink": {
                    "api_key_set": true
                }
            },
            "district": {
                "id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
                "name": "Central Texas",
                "external_id": "CTX",
                "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z",
                "districtGroup": {
                    "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                    "name": "Region",
                    "index": 1,
                    "created_at": "2025-03-14T15:22:08.000000Z",
                    "updated_at": "2026-10-02T09:41:55.000000Z"
                }
            },
            "district2": {
                "id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
                "name": "Central Texas",
                "external_id": "CTX",
                "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z",
                "districtGroup": {
                    "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                    "name": "Region",
                    "index": 1,
                    "created_at": "2025-03-14T15:22:08.000000Z",
                    "updated_at": "2026-10-02T09:41:55.000000Z"
                }
            },
            "locationCategory": {
                "id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
                "name": "Inline",
                "external_id": "INLINE",
                "location_category_group_id": "f2b6d8a1-4c3e-4e7b-a5d9-1c8e3f6b2a40",
                "sort_order": 1,
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z",
                "locationCategoryGroup": {
                    "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                    "name": "Region",
                    "index": 1,
                    "created_at": "2025-03-14T15:22:08.000000Z",
                    "updated_at": "2026-10-02T09:41:55.000000Z"
                }
            },
            "locationGroups": [
                {
                    "id": "a3c5e7f9-2b4d-4f6a-8c1e-3d5f7a9b1c20",
                    "name": "Austin Metro",
                    "external_id": "AUS-METRO",
                    "created_at": "2025-03-14T15:22:08.000000Z",
                    "updated_at": "2026-10-02T09:41:55.000000Z",
                    "locations": [
                        {}
                    ]
                }
            ]
        }
    }
}

{
    "message": "Unauthenticated."
}