API Reference

Add a job

post
https://api.timeero.app/api/public/jobs

Add a job to the company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the job.

string

A brief description of the job.

boolean

Indicates whether mileage tracking is enabled for the job

boolean

Indicates whether users must be within the geofence to perform job-related actions. All the fields are optional except street, city, state, zip_code and country are required when require_geofence is true or 1 and latitude and longitude are not provided.

string

The street address of the job location.

string

A nearby landmark to help identify the job location.

string

The state or region where the job is located.

string

The city where the job is located.

string

The ZIP or postal code of the job location.

string

The country where the job is located.

double

The latitude coordinate of the job location.

double

The longitude coordinate of the job location.

integer

The geofence radius around the job location, in meters.

boolean

Indicates whether a contact person is required for the job (true = required, false = not required). contact_name, contact_phone, contact_mobile, and contact_email are required when contact_required is true.

string

The name of the job contact person.

string

The phone number of the job contact person.

string

The mobile number of the job contact person.

string

The email address of the job contact person.

geofence_members
array of integers

A list of user IDs allowed to access or operate within the job’s geofence.

geofence_members
users
array of integers

A list of user IDs assigned to the job.

users
json
enum

An object containing user-defined job's custom fields. Each key is a custom field ID, and each value is the corresponding field value. Field IDs and values vary depending on the configuration. Only available on Permium plan. For more details, see the Custom Field Guide.

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago