Users
Retrieves a specific User
get/api/v2/partner/users/{id}
Request
- Base URL: http://localhost:5100
- URL: http://localhost:5100/api/v2/partner/users/{id}
- Auth: API key in header Authorization
Path parameters
idstring required
Partner User Identifier
Query parameters
client_idstring required
Partner Client ID
actor_identifierstring required
Partner User Identifier of the actor performing the action
Response
User fetched successfully
Example response
{
"success": true,
"user": {
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"probation_end_date": "2024-12-31",
"termination_date": "2025-06-30",
"hours_per_week": "37.5",
"annual_gross_salary": "45000.0",
"ni_number": "AB123456C",
"pay_frequency": "Monthly",
"employee_number": "EMP001",
"roles": [
"user"
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.