Back to skills
extension
Category: Data & AnalyticsAPI key required

global-company-employee

Official skill for upkuajing (跨境魔方). Query employee list (员工列表) from the global company database (全球企业库). Get employee information including person IDs and j...

personAuthor: upkuajinghubclawhub

Global Company Employee Query

Query employee data from the global company database (全球企业库) using the UpKuaJing Open Platform API.

Overview

This skill provides access to employee information from UpKuaJing's global company database. Given a company ID (pid), it returns the list of employees with their person IDs and job titles.

Prerequisite: The company ID (pid) is required as input. If the user does not already have a company ID, use the global-company-search skill first to search for the target company and obtain its pid, then proceed with this skill.

Running Scripts

Environment Setup

  1. Check Python: python --version
  2. Install dependencies: pip install -r requirements.txt

Script directory: scripts/*.py Run example: python scripts/*.py

Important: Always use direct script invocation like python scripts/company_employee_list.py. Do NOT use shell compound commands like cd scripts && python company_employee_list.py

Employee List Query (company_employee_list.py)

  • Return granularity: Each employee as one record
  • Use cases: Query employees of a specific company
  • Examples:
    • "List employees of company US_12345"
    • "Get more employees using the next page cursor"
  • Parameters: See Employee List API

API Key and Top-up

This skill requires an API key. The API key is stored in the ~/.upkuajing/.env file:

cat ~/.upkuajing/.env

Example file content:

UPKUAJING_API_KEY=your_api_key_here

API Key Not Set

First check if the ~/.upkuajing/.env file has UPKUAJING_API_KEY; If UPKUAJING_API_KEY is not set, prompt the user to choose:

  1. User has one: User provides it (manually add to ~/.upkuajing/.env file)
  2. User doesn't have one: You can apply using the interface (auth.py --new_key), the new key will be automatically saved to ~/.upkuajing/.env Wait for user selection;

Account Top-up

When API response indicates insufficient balance, explain and guide user to top up:

  1. Create top-up order (auth.py --new_rec_order)
  2. Based on order response, send payment page URL to user, guide user to open URL and pay, user confirms after successful payment;

Get Account Information

Use this script to get account information for UPKUAJING_API_KEY: auth.py --account_info

API Key and UpKuaJing Account

Fees

All API calls incur fees, different interfaces have different billing methods.

Latest pricing: Users can visit Detailed Price Description Or use: python scripts/auth.py --price_info (returns complete pricing for all interfaces)

Query Billing Rules

Billed by number of calls, each call returns one page of employee records:

  • Each API call incurs a fee
  • Use --cursor to get additional pages (each page is a separate call)
  • Before execution:
    1. Inform user that this query will incur a fee
    2. Stop, wait for explicit user confirmation in a separate message, then execute script

Fee Confirmation Principle

Any operation that incurs fees must first inform and wait for explicit user confirmation. Do not execute in the same message as the notification.

Workflow

Decision Guide

| User Intent | Use API | |-------------|---------| | "List employees of company US_12345" | Employee List Query | | User has a company name but no pid | global-company-search (find the company and get its pid, then use this skill) |

Usage Examples

Query Employee List

User request: "List employees of company US_12345"

python scripts/company_employee_list.py --pid US_12345

Get next page (use cursor returned from previous response):

python scripts/company_employee_list.py --pid US_12345 --cursor 'cursor_string_from_previous_response'

Error Handling

  • API key invalid/non-existent: Check UPKUAJING_API_KEY in ~/.upkuajing/.env file
  • Insufficient balance: Guide user to top up
  • Invalid parameters: Must first check the corresponding API documentation in references/ directory, get correct parameter names and formats from documentation, do not guess

API Documentation Reference

Best Practices

  1. Check API documentation:

    • Before executing queries, must first check the corresponding API reference documentation
    • Check references/company-employee-list-api.md
    • Do not guess parameter names, get accurate parameter names and formats from documentation
  2. Query parameters:

    • The company ID (pid) is required. If the user provides a company name instead of a pid, first use global-company-search to find the company and obtain its pid. It can also be obtained from other global company search skills.
  3. Pagination:

    • When the response returns a non-empty cursor, more data is available
    • Pass the cursor value to get the next page
    • An empty cursor means there is no more data

Notes

  • Employee records use hid as the person unique identifier; pid is the company identifier
  • titleNames is a list of job title strings for each employee
  • File paths use forward slashes on all platforms
  • Prohibit outputting technical parameter format: Do not display code-style parameters in responses, convert to natural language
  • Do not estimate or guess per-call fees — use python scripts/auth.py --price_info to get accurate pricing information
  • Do not guess parameter names, get accurate parameter names and formats from documentation

Related Skills

Other UpKuaJing skills you might find useful:

  • global-company-search — Search companies from the global company database
  • global-company-person-search — Search people from the global company database
  • global-company-shareholder — Query shareholder list from the global company database
  • global-company-person-colleague — Query colleague list from the global company database
  • global-company-person-alumni — Query alumni list from the global company database
  • global-company-person-experience — Query work experience list from the global company database
  • global-company-person-education — Query education history list from the global company database
  • global-company-person-school-detail — Query school detail from the global company database
  • linkedin-person-search — Search people from LinkedIn data
  • linkedin-company-search — Search companies from LinkedIn data
  • upkuajing-global-company-people-search — Unified company and people search across all sources
  • upkuajing-customs-trade-company-search — Search customs trade companies
  • upkuajing-contact-info-validity-check — Check contact info validity