Browse docs

API Overview

Choose the correct Job Creator export, shared Jobs Base API or administrator integration.

Job Creator uses the shared Sky Base and Jobs Base services. A job created in /jobcreator uses those same gameplay APIs; there is no separate Creator version of duty, employees, society money or garage storage.

Choose an integration

TaskReferenceExecution side
Inspect automatic framework installation or wait for definition startupServer ExportsServer
Read an employee's job, change duty, manage members or integrate business toolsShared Job APIsAs stated by each shared API
Understand catalog, statistics, administrator actions and callback boundariesAdministration APIServer; administrator access required
Import the shared library and inspect initializationJobs Base Library and StartupClient and server, with separate readiness

Resource names

Use sky_jobcreator for the resource dependency and its three server exports. Job Creator currently registers no client exports and no general-purpose CreateJob, DeleteJob or OpenJobCreator export.

Shared calls still target sky_jobs_base or sky_base. For example, getPlayerJobInfo is an export of sky_jobs_base, not sky_jobcreator. Names and capitalization are significant.

Some saved configuration and ownership keys intentionally retain sky_jobscreator, sky_jobscreator_gangs or sky_jobscreator_migration. These are persistent identities, not alternate resource names. Do not rename existing database rows or saved settings to match a Lua export call.

Startup and authority

Declare the resource that supplies your API as a dependency in your integration's fxmanifest.lua:

fxmanifest.lua
dependency "sky_jobcreator"

Use dependency "sky_jobs_base" instead when your script only needs the shared gameplay APIs. Follow each API's startup contract: a resource being started, Creator's definition gate and Jobs Base's completed initialization are different states.

Exports are resource-to-resource calls on their documented side. They are not HTTP endpoints or permission grants. A trusted server integration must authorize its own player-facing requests. Use the actual request's player source and server-owned job state; a client-supplied job, rank or administrator identity is not authority.

For normal administration, use /jobcreator. Its save, retry, review and migration flows retain their existing validation and audit trail. Internal NUI callbacks and Community Hub requests are not a public automation API.