Skip to main content
GET
https://sandbox.finhub.cloud
/
api
/
v2.1
/
customer
/
organization
/
{organizationId}
/
employees
Organization Employees API
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/employees \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "department": "<string>",
  "role": "<string>",
  "permissions": [
    {}
  ]
}
'
{
  "success": true,
  "data": {
    "employees": [
      {
        "employeeId": "emp_12345",
        "firstName": "Alice",
        "lastName": "Worker",
        "email": "[email protected]",
        "department": "Finance",
        "role": "ACCOUNTANT",
        "status": "ACTIVE",
        "hiredDate": "2023-03-15"
      }
    ],
    "pagination": {
      "total": 25,
      "page": 0,
      "size": 20
    }
  }
}

​
Organization Employees API

APIs for managing employees and their roles within business organizations.
Base URL: https://sandbox.finhub.cloud

​
Available Operations

List Employees

GET /employees

Add Employee

POST /employees

Update Roles

PUT /employees/{id}/roles

​
List Employees

Retrieves all employees for an organization with their assigned roles.
For complete details on authentication and headers, refer to the Standard HTTP Headers reference documentation.

​
Request

​
organizationId
string
required
Organization identifier
​
Authorization
string
required
Bearer token for authentication
​
X-Tenant-ID
string
required
Tenant identifier
​
department
string
Filter by department
​
role
string
Filter by role

​
Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/employees?department=Finance" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

{
  "success": true,
  "data": {
    "employees": [
      {
        "employeeId": "emp_12345",
        "firstName": "Alice",
        "lastName": "Worker",
        "email": "[email protected]",
        "department": "Finance",
        "role": "ACCOUNTANT",
        "status": "ACTIVE",
        "hiredDate": "2023-03-15"
      }
    ],
    "pagination": {
      "total": 25,
      "page": 0,
      "size": 20
    }
  }
}

​
Add Employee

Adds a new employee to the organization (requires ADMIN role).

​
Request

​
organizationId
string
required
Organization identifier
​
firstName
string
required
Employee first name
​
lastName
string
required
Employee last name
​
email
string
required
Employee email address
​
phone
string
Employee phone number
​
department
string
required
Department name
​
role
string
required
Employee role: ADMIN, OPERATOR, ACCOUNTANT, VIEWER
​
permissions
array
List of specific permissions

​
Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/employees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Bob",
    "lastName": "NewHire",
    "email": "[email protected]",
    "phone": "+49123456789",
    "department": "Operations",
    "role": "OPERATOR",
    "permissions": ["VIEW_TRANSACTIONS", "INITIATE_PAYMENTS"]
  }'

{
  "success": true,
  "data": {
    "employeeId": "emp_67890",
    "userId": "user_11111",
    "status": "PENDING_ACTIVATION",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

​
Remove Employee

Removes an employee from the organization.

​
Code Examples

curl -X DELETE "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/employees/emp_67890" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

​
Employee Roles

RoleDescription
ADMINFull organization access
OPERATORTransaction operations
ACCOUNTANTFinancial reporting
VIEWERRead-only access

​
Response Codes

CodeDescription
200Employees retrieved/updated successfully
201Employee added successfully
204Employee removed successfully
400Invalid request data or role validation failed
403Access denied
404Organization not found
500Internal server error

​
API Schema Reference

For the complete OpenAPI schema specification, see the API Schema Mapping document.

Standard Headers

Complete HTTP headers reference

Organization Registration

Register new organizations

Directors

Manage organization directors

Shareholders

Manage organization shareholders