Browse docs
API overview
Use these integrations to connect your own scripts to a Creator job. In the sidebar, expand Client exports or Server exports to choose a feature, or open Events to react to changes.
Use exports["sky_jobs_base"] for gameplay. Job Creator uses Jobs Base for duty, employees, company accounts, billing, storage, vehicles and player actions. These APIs work with registered Creator jobs as well as other supported Sky jobs.
Export names are case-sensitive: getPlayerJobInfo and OpenBilling have different capitalization. Copy the name exactly as shown. You do not need to import the Sky library just to call an export.
Choose an integration
| You want to… | Start here |
|---|---|
| Read a player's job, grade or duty state | Server exports → Job and duty |
| Hire, promote or dismiss employees | Server exports → Employees |
| Read or change a company balance | Server exports → Company accounts |
| Issue an invoice or react to a payment | Server exports → Billing |
| Pause payroll or read a grade's salary | Salary |
| Check an employee's permissions | Permissions |
| Open/close a business or publish an announcement | Business |
| Open billing, Business or the radial menu | Client exports |
| Use your own radial or target menu | Client exports → External menus |
| Cuff, escort, search or move a player into a vehicle | Player interactions |
| Show or present identity, licences or a service card | Documents |
| Count, add or remove shared storage items | Storage |
| Register vehicles spawned by another garage | External garage integration |
| Connect a delivery script to wholesale orders | Wholesale orders |
| React to job, duty, membership or invoice changes | Events |
Client or server?
Server exports run in your server script. Use them for job checks, employee management and money changes. Your integration must authorise the action and validate player IDs, grades and amounts.
Client exports run in the player's client script. They open menus for that player or connect client-side actions. The job's enabled features, duty requirements and employee permissions still apply.
First integration
Add Jobs Base as a dependency of your own resource and put each example on the side indicated by its filename:
fx_version "cerulean"
game "gta5"
dependency "sky_jobs_base"
server_script "server.lua"
client_script "client.lua"
Start your integration after sky_base, sky_jobs_base and sky_jobcreator. Use a real technical job name from your server, such as sunrise_cafe, rather than the display label. playerId is an online player's numeric server ID; an identifier is a persistent character ID. They are different inputs.
Calls that contact the server, database or a provider can yield. Call them from a normal script thread or an existing handler that allows yielding. Check the return values shown on that export's page: some return success, reason, some return { success, data, error }, and menu openers may return nothing.
Availability
The job's enabled features, saved configuration, duty rules, rank permissions and providers still apply. Calling an export does not turn a feature on or grant permission. Training, emergency dispatch and the specialist vehicle registry require their owning job resources; they are not generic Creator features.
The topic links in this sidebar lead directly to the complete shared references. There is one reference per feature, so the parameters and examples stay the same wherever you open them.