Organizational Structure

Departments, teams, and hierarchical relationships

All endpoints require authentication. Include your access token in the Authorization header: Authorization: Bearer your_access_token

InternalGET/v1/ja/departments

Get all departments

Retrieve all departments within a company with filtering and pagination options

Path Parameters

Query Parameters

Name
parentDepartmentId
Type
string
Description
Filter departments by parent department ID
Name
name
Type
string
Description
Filter departments by name (partial match)
Name
limit
Type
integer
Description
Number of departments to return (default: 50, max: 100)
Name
offset
Type
integer
Description
Number of departments to skip for pagination

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
array<object>
Description
Array of department objects, each containing:
- id (string): Unique identifier for the department
- name (string): Department name
- description (string): Department description
- teamCount (integer): Number of teams in this department
- employeeCount (integer): Number of employees in this department
- parentDepartmentId (string): Parent department ID (if applicable)
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp
Name
pagination
Type
object
Description
Pagination information containing:
- total (integer): Total number of departments
- limit (integer): Number of items per page
- offset (integer): Starting position
- hasMore (boolean): Whether more results are available

Request

GET

/v1/ja/departments

curl https://frontier.beamery.com/v1/ja/departments \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-123456789012",
      "name": "Retail Banking Operations",
      "description": "Responsible for providing retail banking services to individual customers, including account management, customer service, and branch operations. This department focuses on customer experience and operational efficiency.",
      "teamCount": 8,
      "employeeCount": 250,
      "parentDepartmentId": null,
      "createdAt": "2024-01-10T09:15:00Z",
      "updatedAt": "2024-01-25T14:30:00Z"
    },
    {
      "id": "b2c3d4e5-f6g7-8901-bcde-234567890123",
      "name": "Data Analytics",
      "description": "Develops and maintains data analytics capabilities, including business intelligence, machine learning, and data science initiatives. This department is responsible for data-driven insights and predictive analytics.",
      "teamCount": 5,
      "employeeCount": 85,
      "parentDepartmentId": "c3d4e5f6-g7h8-9012-cdef-345678901234",
      "createdAt": "2024-01-05T08:00:00Z",
      "updatedAt": "2024-01-30T16:45:00Z"
    },
    {
      "id": "c3d4e5f6-g7h8-9012-cdef-345678901234",
      "name": "Engineering",
      "description": "Software development and technical operations including backend systems, frontend applications, and infrastructure management. This department ensures the technical foundation of all digital services.",
      "teamCount": 12,
      "employeeCount": 180,
      "parentDepartmentId": null,
      "createdAt": "2024-01-01T10:00:00Z",
      "updatedAt": "2024-02-01T11:20:00Z"
    }
  ],
  "pagination": {
    "total": 15,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

InternalGET/v1/ja/departments/{departmentId}

Get department

Retrieve detailed information about a specific department with teams, roles, and metrics

Path Parameters

Name
departmentId
Type
string
Description
Unique identifier for the department

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Detailed department information containing:
- id (string): Unique identifier for the department
- name (string): Department name
- description (string): Department description
- teamCount (integer): Number of teams in this department
- employeeCount (integer): Number of employees in this department
- parentDepartmentId (string): Parent department ID (if applicable)
- teams (array): List of teams in this department
- budget (object): Budget information
- location (object): Department location information
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp

Request

GET

/v1/ja/departments/{departmentId}

curl https://frontier.beamery.com/v1/ja/departments/{departmentId} \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-123456789012",
    "name": "Retail Banking Operations",
    "description": "Responsible for providing retail banking services to individual customers, including account management, customer service, and branch operations. This department focuses on customer experience and operational efficiency.",
    "teamCount": 8,
    "employeeCount": 250,
    "parentDepartmentId": null,
    "teams": [
      {
        "id": "f1a2b3c4-d5e6-7890-fghi-123456789012",
        "name": "Personal Banking Services",
        "employeeCount": 45
      },
      {
        "id": "f2b3c4d5-e6f7-8901-ghij-234567890123",
        "name": "Branch Operations",
        "employeeCount": 35
      }
    ],
    "budget": {
      "annual": 2450000,
      "currency": "USD",
      "fiscal_year": "2024"
    },
    "location": {
      "headquarters": {
        "id": "loc1a2b3-c4d5-6789-abcd-123456789012",
        "address": "New York, NY, USA",
        "city": "New York",
        "country": "United States",
        "countryCode": "US",
        "geometry": {
          "type": "Point",
          "coordinates": [-74.006, 40.7128]
        }
      },
      "branches": [
        {
          "id": "loc2b3c4-d5e6-7890-bcde-234567890123",
          "address": "Chicago, IL, USA",
          "city": "Chicago",
          "country": "United States",
          "countryCode": "US",
          "geometry": {
            "type": "Point",
            "coordinates": [-87.6298, 41.8781]
          }
        },
        {
          "id": "loc3c4d5-e6f7-8901-cdef-345678901234",
          "address": "Los Angeles, CA, USA",
          "city": "Los Angeles",
          "country": "United States",
          "countryCode": "US",
          "geometry": {
            "type": "Point",
            "coordinates": [-118.2437, 34.0522]
          }
        },
        {
          "id": "loc4d5e6-f7g8-9012-defg-456789012345",
          "address": "Houston, TX, USA",
          "city": "Houston",
          "country": "United States",
          "countryCode": "US",
          "geometry": {
            "type": "Point",
            "coordinates": [-95.3698, 29.7604]
          }
        }
      ]
    },
    "createdAt": "2024-01-10T09:15:00Z",
    "updatedAt": "2024-01-25T14:30:00Z"
  }
}

InternalPOST/v1/ja/departments

Create department

Create a new department

Path Parameters

Request Body

Name
name
Type
string
Description
Department name
Name
description
Type
string
Description
Department description
Name
parentDepartmentId
Type
string
Description
Parent department ID for hierarchical structure
Name
budget
Type
object
Description
Budget information with annual amount and currency
Name
location
Type
object
Description
Location information including headquarters and branches

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Created department details containing:
- id (string): Unique identifier for the department
- name (string): Department name
- description (string): Department description
- parentDepartmentId (string): Parent department ID (if applicable)
- budget (object): Budget information
- location (object): Location information
- teamCount (integer): Number of teams (initially 0)
- employeeCount (integer): Number of employees (initially 0)
- createdAt (string): Creation timestamp

Request

POST

/v1/ja/departments

curl https://frontier.beamery.com/v1/ja/departments \
  -X POST \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Digital Innovation",
        "description": "Drives digital transformation and fintech initiatives",
        "parentDepartmentId": "c3d4e5f6-g7h8-9012-cdef-345678901234",
        "budget": {
          "annual": 1500000,
          "currency": "USD"
        },
        "location": {
          "headquarters": {
            "id": "loc5e6f7-g8h9-0123-efgh-567890123456",
            "address": "Austin, TX, USA",
            "city": "Austin",
            "country": "United States",
            "countryCode": "US",
            "geometry": {
              "type": "Point",
              "coordinates": [-97.7431, 30.2672]
            }
          },
          "branches": [
            {
              "id": "loc6f7g8-h9i0-1234-fghi-678901234567",
              "address": "Dallas, TX, USA",
              "city": "Dallas",
              "country": "United States",
              "countryCode": "US",
              "geometry": {
                "type": "Point",
                "coordinates": [-96.7970, 32.7767]
              }
            },
            {
              "id": "loc7g8h9-i0j1-2345-ghij-789012345678",
              "address": "San Antonio, TX, USA",
              "city": "San Antonio",
              "country": "United States",
              "countryCode": "US",
              "geometry": {
                "type": "Point",
                "coordinates": [-98.4936, 29.4241]
              }
            }
          ]
        }
    }'

Response

{
  "success": true,
  "data": {
    "id": "d4h5i6j7-k8l9-0123-nopq-456789012345",
    "name": "Digital Innovation",
    "description": "Drives digital transformation and fintech initiatives",
    "parentDepartmentId": "d3g4h5i6-j7k8-9012-lmno-345678901234",
    "budget": {
      "annual": 1500000,
      "currency": "USD"
    },
    "location": {
      "headquarters": "Austin, TX",
      "branches": ["Dallas, TX", "San Antonio, TX"]
    },
    "teamCount": 0,
    "employeeCount": 0,
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

InternalPATCH/v1/ja/departments/{departmentId}

Update department

Update department information like name and description

Path Parameters

Name
departmentId
Type
string
Description
Unique identifier for the department

Request Body

Name
name
Type
string
Description
Updated department name
Name
description
Type
string
Description
Updated department description
Name
parentDepartmentId
Type
string
Description
Updated parent department ID
Name
budget
Type
object
Description
Updated budget information
Name
location
Type
object
Description
Updated location information

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Updated department details containing:
- id (string): Unique identifier for the department
- name (string): Department name
- description (string): Department description
- parentDepartmentId (string): Parent department ID
- budget (object): Budget information
- location (object): Location information
- teamCount (integer): Number of teams
- employeeCount (integer): Number of employees
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp

Request

PATCH

/v1/ja/departments/{departmentId}

curl https://frontier.beamery.com/v1/ja/departments/{departmentId} \
  -X PATCH \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "example_name",
        "description": "example_description"
    }'

Response

{
  "success": true
}

InternalDELETE/v1/ja/departments/{departmentId}

Delete department

Delete a specific department permanently

Path Parameters

Name
departmentId
Type
string
Description
Unique identifier for the department

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Response data containing:
- message (string): Success message confirming department deletion

Request

DELETE

/v1/ja/departments/{departmentId}

curl https://frontier.beamery.com/v1/ja/departments/{departmentId} \
  -X DELETE \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "message": "Department successfully deleted"
  }
}

InternalGET/v1/ja/teams

Get all teams

Retrieve all teams within a company with filtering and pagination options

Path Parameters

Query Parameters

Name
departmentId
Type
string
Description
Filter teams by department ID
Name
name
Type
string
Description
Filter teams by name (partial match)
Name
leaderId
Type
string
Description
Filter teams by leader ID
Name
limit
Type
integer
Description
Number of teams to return (default: 50, max: 100)
Name
offset
Type
integer
Description
Number of teams to skip for pagination

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
array<object>
Description
Array of team objects, each containing:
- id (string): Unique identifier for the team
- name (string): Team name
- description (string): Team description
- departmentId (string): Department ID this team belongs to
- employeeCount (integer): Number of employees in this team
- leaderId (string): Team leader ID
- skills (array): Key skills associated with this team, each containing id and name
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp
Name
pagination
Type
object
Description
Pagination information containing:
- total (integer): Total number of teams
- limit (integer): Number of items per page
- offset (integer): Starting position
- hasMore (boolean): Whether more results are available

Request

GET

/v1/ja/teams

curl https://frontier.beamery.com/v1/ja/teams \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": [
    {
      "id": "f1a2b3c4-d5e6-7890-fghi-123456789012",
      "name": "Personal Banking Services",
      "departmentId": "a1b2c3d4-e5f6-7890-abcd-123456789012",
      "description": "Responsible for providing personalized banking services to individual customers, including account management, financial advisory, and customer support.",
      "employeeCount": 45,
      "skills": [
        {"id": "s1a2b3c4-d5e6-7890-fghi-123456789012", "name": "Customer Service"},
        {"id": "s2b3c4d5-e6f7-8901-ghij-234567890123", "name": "Financial Analysis"},
        {"id": "s3c4d5e6-f7g8-9012-hijk-345678901234", "name": "Banking Regulations"},
        {"id": "s4d5e6f7-g8h9-0123-ijkl-456789012345", "name": "Communication"}
      ],
      "createdAt": "2024-01-10T09:15:00Z",
      "updatedAt": "2024-01-25T14:30:00Z"
    },
    {
      "id": "f2b3c4d5-e6f7-8901-ghij-234567890123",
      "name": "Data Analytics Team",
      "departmentId": "b2c3d4e5-f6g7-8901-bcde-234567890123",
      "description": "Focuses on data analysis, business intelligence, and machine learning initiatives to drive data-driven decision making across the organization.",
      "employeeCount": 35,
      "skills": [
        {"id": "s5e6f7g8-h9i0-1234-jklm-567890123456", "name": "Python"},
        {"id": "s6f7g8h9-i0j1-2345-klmn-678901234567", "name": "SQL"},
        {"id": "s7g8h9i0-j1k2-3456-lmno-789012345678", "name": "Machine Learning"},
        {"id": "s8h9i0j1-k2l3-4567-mnop-890123456789", "name": "Data Visualization"}
      ],
      "createdAt": "2024-01-05T08:00:00Z",
      "updatedAt": "2024-01-30T16:45:00Z"
    },
    {
      "id": "f3c4d5e6-f7g8-9012-hijk-345678901234",
      "name": "Backend Development",
      "departmentId": "c3d4e5f6-g7h8-9012-cdef-345678901234",
      "description": "Develops and maintains server-side applications, APIs, and database systems that power the organization's digital infrastructure.",
      "employeeCount": 28,
      "skills": [
        {"id": "s9i0j1k2-l3m4-5678-nopq-901234567890", "name": "Node.js"},
        {"id": "s5e6f7g8-h9i0-1234-jklm-567890123456", "name": "Python"},
        {"id": "s10j1k2l3-m4n5-6789-opqr-012345678901", "name": "PostgreSQL"},
        {"id": "s11k2l3m4-n5o6-7890-pqrs-123456789012", "name": "Docker"}
      ],
      "createdAt": "2024-01-01T10:00:00Z",
      "updatedAt": "2024-02-01T11:20:00Z"
    }
  ],
  "pagination": {
    "total": 24,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

InternalGET/v1/ja/teams/{teamId}

Get team

Retrieve comprehensive team details with roles, skills, and metrics

Path Parameters

Name
teamId
Type
string
Description
Unique identifier for the team

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Detailed team information containing:
- id (string): Unique identifier for the team
- name (string): Team name
- description (string): Team description
- departmentId (string): Department ID this team belongs to
- employeeCount (integer): Number of employees in this team
- leaderId (string): Team leader ID
- members (array): Team members with roles and skills
- skills (array): Key skills associated with this team, each containing id and name
- projects (array): Current projects
- budget (object): Team budget information
- location (object): Team location information
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp

Request

GET

/v1/ja/teams/{teamId}

curl https://frontier.beamery.com/v1/ja/teams/{teamId} \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "id": "f1a2b3c4-d5e6-7890-fghi-123456789012",
    "name": "Personal Banking Services",
    "departmentId": "a1b2c3d4-e5f6-7890-abcd-123456789012",
    "description": "Responsible for providing personalized banking services to individual customers, including account management, financial advisory, and customer support.",
    "employeeCount": 45,
    "members": [
      {
        "id": "9a1b2c3d-e4f5-6789-abcd-123456789012",
        "name": "Sarah Johnson",
        "role": "Team Lead",
        "skills": [
          {"id": "s1a2b3c4-d5e6-7890-fghi-123456789012", "name": "Customer Service"},
          {"id": "s2b3c4d5-e6f7-8901-ghij-234567890123", "name": "Financial Analysis"},
          {"id": "s12l3m4n5-o6p7-8901-qrst-234567890123", "name": "Team Leadership"}
        ],
        "experience": 8
      },
      {
        "id": "9b2c3d4e-f5g6-7890-bcde-234567890123",
        "name": "Michael Chen",
        "role": "Senior Associate",
        "skills": [
          {"id": "s3c4d5e6-f7g8-9012-hijk-345678901234", "name": "Banking Regulations"},
          {"id": "s1a2b3c4-d5e6-7890-fghi-123456789012", "name": "Customer Service"},
          {"id": "s13m4n5o6-p7q8-9012-rstu-345678901234", "name": "Risk Assessment"}
        ],
        "experience": 5
      }
    ],
    "skills": [
      {"id": "s1a2b3c4-d5e6-7890-fghi-123456789012", "name": "Customer Service"},
      {"id": "s2b3c4d5-e6f7-8901-ghij-234567890123", "name": "Financial Analysis"},
      {"id": "s3c4d5e6-f7g8-9012-hijk-345678901234", "name": "Banking Regulations"},
      {"id": "s4d5e6f7-g8h9-0123-ijkl-456789012345", "name": "Communication"}
    ],
    "projects": [
      {
        "id": "e1a2b3c4-d5e6-7890-fghi-123456789012",
        "name": "Mobile Banking Enhancement",
        "status": "in_progress",
        "priority": "high"
      }
    ],
    "budget": {
      "annual": 850000,
      "currency": "USD",
      "fiscalYear": "2024"
    },
    "location": {
      "primary": {
        "id": "loc8h9i0-j1k2-3456-hijk-890123456789",
        "address": "New York, NY, USA",
        "city": "New York",
        "country": "United States",
        "countryCode": "US",
        "geometry": {
          "type": "Point",
          "coordinates": [-74.006, 40.7128]
        }
      },
      "remote": true,
      "hybridPolicy": "3 days in office"
    },
    "createdAt": "2024-01-10T09:15:00Z",
    "updatedAt": "2024-01-25T14:30:00Z"
  }
}

InternalPOST/v1/ja/teams

Create team

Create a new team

Path Parameters

Request Body

Name
name
Type
string
Description
Team name
Name
description
Type
string
Description
Team description
Name
departmentId
Type
string
Description
Department ID this team belongs to

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Created team details containing:
- id (string): Unique identifier for the team
- name (string): Team name
- departmentId (string): Department ID this team belongs to
- description (string): Team description
- employeeCount (integer): Number of employees (initially 0)
- createdAt (string): Creation timestamp

Request

POST

/v1/ja/teams

curl https://frontier.beamery.com/v1/ja/teams \
  -X POST \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Backend Team",
        "description": "Server-side development team",
        "departmentId": "dept-456"
    }'

Response

{
  "success": true,
  "data": {
    "id": "team-123",
    "name": "Backend Team",
    "description": "Server-side development team",
    "departmentId": "dept-456",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

InternalPATCH/v1/ja/teams/{teamId}

Update team

Update team information like name and department assignment

Path Parameters

Name
teamId
Type
string
Description
Unique identifier for the team

Request Body

Name
name
Type
string
Description
Updated team name
Name
departmentId
Type
string
Description
Updated department ID this team belongs to
Name
description
Type
string
Description
Updated team description

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Updated team details containing:
- id (string): Unique identifier for the team
- name (string): Team name
- departmentId (string): Department ID this team belongs to
- description (string): Team description
- employeeCount (integer): Number of employees in this team
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp

Request

PATCH

/v1/ja/teams/{teamId}

curl https://frontier.beamery.com/v1/ja/teams/{teamId} \
  -X PATCH \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "example_name",
        "departmentId": "example_departmentId",
        "description": "example_description"
    }'

Response

{
  "success": true,
  "data": {
    "id": "f3c4d5e6-f7g8-9012-hijk-345678901234",
    "name": "Backend Development Team",
    "departmentId": "c3d4e5f6-g7h8-9012-cdef-345678901234",
    "description": "Server-side development team responsible for API and database systems",
    "employeeCount": 28,
    "createdAt": "2024-01-01T10:00:00Z",
    "updatedAt": "2024-02-01T11:20:00Z"
  }
}

InternalDELETE/v1/ja/teams/{teamId}

Delete team

Delete a specific team permanently

Path Parameters

Name
teamId
Type
string
Description
Unique identifier for the team

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Response data containing:
- message (string): Success message confirming team deletion

Request

DELETE

/v1/ja/teams/{teamId}

curl https://frontier.beamery.com/v1/ja/teams/{teamId} \
  -X DELETE \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "message": "Team successfully deleted"
  }
}

InternalGET/v1/ja/org-structures

Get all organizational structures

Retrieve all organizational structures with filtering and pagination options

Path Parameters

Query Parameters

Name
companyId
Type
string
Description
Filter by company ID
Name
businessUnitId
Type
string
Description
Filter by business unit ID
Name
limit
Type
integer
Description
Number of structures to return (default: 50, max: 100)
Name
offset
Type
integer
Description
Number of structures to skip for pagination

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
array<object>
Description
Array of organizational structure objects
Name
pagination
Type
object
Description
Pagination information

Request

GET

/v1/ja/org-structures

curl https://frontier.beamery.com/v1/ja/org-structures \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": [
    {
      "id": "h1a2b3c4-d5e6-7890-hijk-123456789012",
      "businessUnits": [
        {
          "id": "i1a2b3c4-d5e6-7890-ijkl-123456789012",
          "name": "Consumer Banking",
          "description": "Retail banking services and credit card solutions"
        },
        {
          "id": "i2b3c4d5-e6f7-8901-jklm-234567890123",
          "name": "Corporate & Investment Banking",
          "description": "Financial advisory and capital markets services"
        }
      ],
      "totalEmployees": 3500,
      "hierarchyLevels": 5,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

InternalGET/v1/ja/org-structure

Get organizational structure

Retrieve/generate organizational structure with business units

Path Parameters

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Organizational structure data containing:
- businessUnits (array): List of business units with departments
- totalEmployees (integer): Total number of employees across all units
- hierarchyLevels (integer): Number of organizational hierarchy levels

Request

GET

/v1/ja/org-structure

curl https://frontier.beamery.com/v1/ja/org-structure \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "businessUnits": [
      {
        "id": "i1a2b3c4-d5e6-7890-ijkl-123456789012",
        "name": "Consumer Banking",
        "description": "Focuses on providing retail banking services and credit card solutions to individual customers.",
        "departments": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-123456789012",
            "name": "Retail Banking Operations",
            "employeeCount": 450
          },
          {
            "id": "a2b3c4d5-e6f7-8901-bcde-234567890123",
            "name": "Credit Card Services",
            "employeeCount": 320
          }
        ]
      },
      {
        "id": "i2b3c4d5-e6f7-8901-jklm-234567890123",
        "name": "Corporate & Investment Banking",
        "description": "Offers financial advisory, mergers and acquisitions, and capital markets services to corporate clients.",
        "departments": [
          {
            "id": "a3c4d5e6-f7g8-9012-cdef-345678901234",
            "name": "Investment Banking",
            "employeeCount": 280
          }
        ]
      },
      {
        "id": "i3c4d5e6-f7g8-9012-klmn-345678901234",
        "name": "Innovation & Sustainability",
        "description": "Drives digital transformation and sustainable finance initiatives, integrating fintech and ESG principles.",
        "departments": [
          {
            "id": "a4d5e6f7-g8h9-0123-defg-456789012345",
            "name": "Digital Innovation",
            "employeeCount": 180
          },
          {
            "id": "a5e6f7g8-h9i0-1234-efgh-567890123456",
            "name": "Sustainable Finance",
            "employeeCount": 120
          }
        ]
      }
    ],
    "totalEmployees": 3500,
    "hierarchyLevels": 5
  }
}

InternalPOST/v1/ja/org-structure

Create organizational structure

Create or update organizational structure data

Path Parameters

Request Body

Name
structure
Type
object
Description
Organizational structure data containing business units and hierarchy information

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Created organizational structure data containing:
- id (string): Unique identifier for the organizational structure
- businessUnits (array): List of business units with departments
- totalEmployees (integer): Total number of employees across all units
- hierarchyLevels (integer): Number of organizational hierarchy levels
- createdAt (string): Creation timestamp
- updatedAt (string): Last update timestamp

Request

POST

/v1/ja/org-structure

curl https://frontier.beamery.com/v1/ja/org-structure \
  -X POST \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "structure": {
      "companyId": "g1a2b3c4-d5e6-7890-ghij-123456789012",
      "businessUnits": [
        {
          "id": "i1a2b3c4-d5e6-7890-ijkl-123456789012",
          "name": "Consumer Banking",
          "description": "Retail banking services and credit card solutions",
          "departments": [
            {
              "id": "a1b2c3d4-e5f6-7890-abcd-123456789012",
              "name": "Retail Banking Operations",
              "employeeCount": 450
            },
            {
              "id": "a2b3c4d5-e6f7-8901-bcde-234567890123",
              "name": "Credit Card Services",
              "employeeCount": 320
            }
          ]
        },
        {
          "id": "i2b3c4d5-e6f7-8901-jklm-234567890123",
          "name": "Corporate & Investment Banking",
          "description": "Financial advisory, mergers and acquisitions, and capital markets services",
          "departments": [
            {
              "id": "a3c4d5e6-f7g8-9012-cdef-345678901234",
              "name": "Investment Banking",
              "employeeCount": 280
            }
          ]
        }
      ],
      "hierarchyLevels": 5
    }
  }'

Response

{
  "success": true,
  "data": {
    "id": "h1a2b3c4-d5e6-7890-hijk-123456789012",
    "businessUnits": [
      {
        "id": "i1a2b3c4-d5e6-7890-ijkl-123456789012",
        "name": "Consumer Banking",
        "description": "Retail banking services and credit card solutions",
        "departments": [
          {
            "id": "a1b2c3d4-e5f6-7890-abcd-123456789012",
            "name": "Retail Banking Operations",
            "employeeCount": 450
          },
          {
            "id": "a2b3c4d5-e6f7-8901-bcde-234567890123",
            "name": "Credit Card Services",
            "employeeCount": 320
          }
        ]
      },
      {
        "id": "i2b3c4d5-e6f7-8901-jklm-234567890123",
        "name": "Corporate & Investment Banking",
        "description": "Financial advisory, mergers and acquisitions, and capital markets services",
        "departments": [
          {
            "id": "a3c4d5e6-f7g8-9012-cdef-345678901234",
            "name": "Investment Banking",
            "employeeCount": 280
          }
        ]
      }
    ],
    "totalEmployees": 1050,
    "hierarchyLevels": 5,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

InternalGET/v1/ja/teams/{teamId}/insights

Get team insights

Retrieve AI-powered insights for specific team analysis

Path Parameters

Name
teamId
Type
string
Description
Unique identifier for the team

Query Parameters

Name
analysisType
Type
string
Description
Type of insights to retrieve (performance, skills, collaboration, productivity)
Name
analysis
Type
string
Description
Specific analysis section to retrieve. Available options:
- performanceInsights - Team performance analysis
- skillsAnalysis - Team skills assessment
- collaborationMetrics - Team collaboration insights
- productivityAnalysis - Team productivity metrics
- recommendations - AI-powered recommendations If not specified, returns all analysis sections

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
object
Description
Team insights data containing:
- teamId (string): The team identifier
- analysisDate (string): When the analysis was generated
- analysisType (string): Type of insights generated
- overallScore (number): Overall team health score
- analysis (object): Analysis sections (Alpha feature) containing:
  - performanceInsights (object): Team performance analysis
  - skillsAnalysis (object): Team skills assessment
  - collaborationMetrics (object): Team collaboration insights
  - productivityAnalysis (object): Team productivity metrics
  - recommendations (array): AI-powered recommendations

Request

GET

/v1/ja/teams/{teamId}/insights

curl "https://frontier.beamery.com/v1/ja/teams/{teamId}/insights?analysisType=performance&analysis=performanceInsights" \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": {
    "teamId": "b2c3d4e5-f6g7-8901-hijk-123456789012",
    "analysisDate": "2024-01-15T10:30:00Z",
    "analysisType": "performance",
    "overallScore": 8.2,
    "analysis": {
      "performanceInsights": {
        "productivityScore": 8.5,
        "qualityScore": 7.8,
        "velocityTrend": "increasing",
        "keyMetrics": {
          "throughput": 23.5,
          "cycleTime": 4.2,
          "defectRate": 0.08
        }
      },
      "skillsAnalysis": {
        "skillCoverage": 0.82,
        "criticalSkills": [
          {
            "skill": "React Development",
            "proficiency": "expert",
            "teamCoverage": 0.75
          },
          {
            "skill": "Node.js",
            "proficiency": "intermediate",
            "teamCoverage": 0.60
          }
        ],
        "skillGaps": [
          {
            "skill": "DevOps",
            "currentLevel": "beginner",
            "targetLevel": "intermediate",
            "priority": "high"
          }
        ]
      },
      "collaborationMetrics": {
        "communicationScore": 8.1,
        "knowledgeSharing": 7.5,
        "crossTraining": 0.65,
        "teamSynergy": "high"
      },
      "productivityAnalysis": {
        "efficiencyScore": 8.3,
        "utilizationRate": 0.78,
        "automationLevel": 0.45,
        "bottlenecks": [
          {
            "area": "Code Review",
            "impact": "medium",
            "solution": "Implement automated review tools"
          }
        ]
      },
      "recommendations": [
        {
          "type": "skill_development",
          "priority": "high",
          "description": "Invest in DevOps training for team members",
          "impact": "productivity_improvement",
          "timeline": "3-6 months"
        },
        {
          "type": "process_optimization",
          "priority": "medium",
          "description": "Implement pair programming sessions",
          "impact": "knowledge_sharing",
          "timeline": "1-2 months"
        }
      ]
    }
  }
}

InternalGET/v1/ja/{orgUnit}/{orgUnitId}/tasks

Get organizational unit tasks

Retrieve tasks for a specific organizational unit (department or team)

Path Parameters

Name
orgUnit
Type
string
Description
Type of organizational unit ("department" or "team")
Name
orgUnitId
Type
string
Description
Unique identifier for the organizational unit

Query Parameters

Name
group
Type
string
Description
Filter tasks by group name
Name
type
Type
string
Description
Filter tasks by type (Technical, Business, etc.)
Name
complexity
Type
string
Description
Filter tasks by complexity level (low, medium, high)
Name
automationPotential
Type
string
Description
Filter tasks by automation potential (low, medium, high)
Name
analysis
Type
string
Description
Specific analysis section to retrieve. Available options:
- taskDistribution - Task distribution across complexity levels
- automationInsights - Automation potential analysis
- skillDemand - Skills demand analysis
- effortAnalysis - Effort distribution analysis If not specified, returns all analysis sections
Name
limit
Type
integer
Description
Number of tasks to return (default: 50, max: 100)
Name
offset
Type
integer
Description
Number of tasks to skip for pagination

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
array<object>
Description
Array of task objects specific to the organizational unit
Name
analysis
Type
object
Description
Analysis sections (Alpha feature) containing:
- taskDistribution (object): Distribution of tasks across complexity levels
- automationInsights (object): Automation potential analysis
- skillDemand (object): Skills demand analysis
- effortAnalysis (object): Effort distribution analysis
Name
pagination
Type
object
Description
Pagination information

Request

GET

/v1/ja/{orgUnit}/{orgUnitId}/tasks

curl https://frontier.beamery.com/v1/ja/department/a1b2c3d4-e5f6-7890-abcd-123456789012/tasks \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": [
    {
      "id": "t1a2b3c4-d5e6-7890-fghi-123456789012",
      "name": "UI Design Review",
      "description": "Review and approve user interface designs for mobile application",
      "automationPotential": 25,
      "effort": "medium",
      "frequency": "weekly",
      "complexity": "high",
      "group": {
        "name": "Design Operations",
        "type": "Creative"
      },
      "skills": [
        {
          "id": "s14n5o6p7-q8r9-0123-stuv-456789012345",
          "name": "UI Design",
          "level": "expert",
          "category": "Design"
        }
      ]
    }
  ],
  "analysis": {
    "taskDistribution": {
      "low": 15,
      "medium": 20,
      "high": 10
    },
    "automationInsights": {
      "averageAutomationPotential": 35,
      "highAutomationTasks": 12,
      "totalEfficiencyGain": "23%"
    },
    "skillDemand": {
      "topSkills": [
        {
          "skill": "UI Design",
          "frequency": 85,
          "trend": "increasing"
        },
        {
          "skill": "User Research",
          "frequency": 72,
          "trend": "stable"
        }
      ]
    },
    "effortAnalysis": {
      "low": 8,
      "medium": 22,
      "high": 15
    }
  },
  "pagination": {
    "total": 45,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

InternalGET/v1/ja/{orgUnit}/{orgUnitId}/skills

Get organizational unit skills

Retrieve skills analysis for a specific organizational unit with market insights

Path Parameters

Name
orgUnit
Type
string
Description
Type of organizational unit ("department" or "team")
Name
orgUnitId
Type
string
Description
Unique identifier for the organizational unit

Query Parameters

Name
category
Type
string
Description
Filter skills by category (Technical, Business, Design, etc.)
Name
level
Type
string
Description
Filter skills by proficiency level (beginner, intermediate, advanced, expert)
Name
jobFamilyGroup
Type
string
Description
Filter by specific job family group (e.g., "Engineering", "Sales", "Marketing")
Name
seniorityLevel
Type
string
Description
Filter by seniority level (e.g., "Executive", "Director", "Mid-Senior")
Name
includeMarketData
Type
boolean
Description
Include market demand and salary data (default: false)
Name
analysis
Type
string
Description
Specific analysis section to retrieve. Available options:
- skillDistribution - Distribution across categories and levels
- gapAnalysis - Skills gaps and recommendations
- marketInsights - Market demand and trends
- organizationalFit - Organizational alignment analysis If not specified, returns all analysis sections
Name
limit
Type
integer
Description
Number of skills to return (default: 50, max: 100)
Name
offset
Type
integer
Description
Number of skills to skip for pagination

Response

Name
success
Type
boolean
Description
Indicates if the request was successful
Name
data
Type
array<object>
Description
Array of skill objects with organizational context
Name
analysis
Type
object
Description
Analysis sections (Alpha feature) containing:
- skillDistribution (object): Distribution across categories and levels
- gapAnalysis (object): Skills gaps and recommendations
- marketInsights (object): Market demand and trends (if includeMarketData=true)
- organizationalFit (object): How skills align with organizational needs
Name
pagination
Type
object
Description
Pagination information

Request

GET

/v1/ja/{orgUnit}/{orgUnitId}/skills

curl "https://frontier.beamery.com/v1/ja/team/b2c3d4e5-f6g7-8901-hijk-123456789012/skills?includeMarketData=true" \
  -H "Authorization: Bearer your_access_token"

Response

{
  "success": true,
  "data": [
    {
      "id": "s15o6p7q8-r9s0-1234-tuvw-567890123456",
      "name": "React Development",
      "category": "Technical",
      "level": "expert",
      "employeeCount": 12,
      "averageExperience": 4.2,
      "certifications": [
        {
          "name": "React Professional Certificate",
          "count": 8
        }
      ],
      "marketData": {
        "demand": "high",
        "growthRate": 15.3,
        "averageSalary": {
          "currency": "USD",
          "min": 85000,
          "max": 150000,
          "average": 118000
        },
        "locationTrends": [
          {
            "location": {
              "id": "loc9i0j1-k2l3-4567-ijkl-901234567890",
              "address": "San Francisco, CA, USA",
              "city": "San Francisco",
              "country": "United States",
              "countryCode": "US",
              "geometry": {
                "type": "Point",
                "coordinates": [-122.4194, 37.7749]
              }
            },
            "demandIndex": 92,
            "salaryPremium": 25
          }
        ]
      }
    }
  ],
  "analysis": {
    "skillDistribution": {
      "technical": 18,
      "business": 8,
      "design": 5,
      "leadership": 3
    },
    "gapAnalysis": {
      "criticalGaps": [
        {
          "skill": "Machine Learning",
          "currentLevel": "beginner",
          "requiredLevel": "intermediate",
          "priority": "high",
          "impact": "Blocks AI initiative progress"
        }
      ],
      "recommendations": [
        {
          "type": "training",
          "skill": "Machine Learning",
          "timeline": "3-6 months",
          "cost": 15000
        }
      ]
    },
    "marketInsights": {
      "trendsAlignment": 78,
      "competitiveAdvantage": [
        {
          "skill": "React Development",
          "advantage": "Above market average",
          "score": 85
        }
      ],
      "riskAreas": [
        {
          "skill": "Legacy Technology",
          "risk": "Declining market demand",
          "mitigation": "Migrate to modern frameworks"
        }
      ]
    },
    "organizationalFit": {
      "alignmentScore": 82,
      "strengthAreas": ["Frontend Development", "User Experience"],
      "developmentAreas": ["Backend Architecture", "DevOps"]
    }
  },
  "pagination": {
    "total": 34,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

EOF < /dev/null