API Docs
Voxbi Cockpit APIs
All endpoints

Get user by NFC badge

Returns a paginated list of tempus android nfc. Use the standard search, sort, page, and perPage query parameters; use filter[key]=value to narrow the result set. Multi-tenant scoping is enforced. Requires a PBX API-key token carrying the terminals ability.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
accept header · string
example: application/json

Responses

Response schema
currentStatusobject | null
The user's ongoing timepoint status (tempus StatusResource) with timepoint_id, start_time, created_at and timepoint_location appended. Null when the user has no ongoing timepoint.
userInfoobject
idstring · uuid
bearerTokenstring
Freshly issued Sanctum token for the badge session.
displayNamestring | null
layoutobject | null
Terminal layout (tempus LayoutResource) with options, layout and preview_url. Null when no layout is configured.
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/AndroidNfc/getUser
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/AndroidNfc/getUser' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/AndroidNfc/getUser', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/AndroidNfc/getUser',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/AndroidNfc/getUser', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"currentStatus": { … },
"id": "550e8400-e29b-41d4-a716-446655440000",
"mxvp_user_id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Working",
"icon": "la la-briefcase",
"fontcolor": "#ffffff",
"backgroundcolor": "#2e7d32",
"payable": true,
"availability": "available",
"sub_statuses": [],
"timepoint_id": "550e8400-e29b-41d4-a716-446655440020",
"start_time": "2026-07-16T08:00:00.000000Z",
"created_at": "2026-07-16T08:00:00.000000Z",
"timepoint_location": "550e8400-e29b-41d4-a716-446655440030"
},
"userInfo": { … },
"id": "550e8400-e29b-41d4-a716-446655440002",
"bearerToken": "42|aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789AbCd",
"displayName": "Jane Smith"
},
"layout": { … }
"options": { … },
"geoEnable": true,
"geoForce": false,
"postAction": false,
"updateTimer": 5000
},
"layout": { … },
"id": "550e8400-e29b-41d4-a716-446655440040",
"name": "Default Tempus",
"type": "default",
"tl_layouts_statuses": []
},
"preview_url": "https://cockpit.voxbi.com/layout-preview/550e8400-e29b-41d4-a716-446655440040"
}
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}