Click or drag to resize
GET /job_types
Print this page

This service is used to retrieve all job types defined for the customer account.


No request body is used for this service.

Optional parameters

ext_infofalse (default), true By default, this call retrieves job types without their associated form templates. For offline use or to improve performance, add this parameter to cause all associated templates to be returned as well.
updated_since ISO 8601 timestamp Finds items by modification time. This retrieves only those objects with one or more timestamp members, one of which falls after the specified timestamp.
list_all false (default), true (only usable with updated_since) If set to true, list_all retrieves a comprehensive list: ProductName returns a larger set of results that includes the IDs (or primary key values) of every object that falls within the selection range and the JSON for the updated objects. Setting list_all to true can be used, for example, if you need to refresh a local cache.

On success, the response is a JSON array of Job Type objects.

Member Type Purpose
id string Uniquely identifies the job type. This is an alphanumeric identifier.
name string A human-readable name for the job type.
formTemplates FormTemplate[] (read-only) An array of form template objects, containing from 0...n.
systemType string (read-only) A human-readable name for the system type (empty if user created type).
If the request fails, an Error Response is generated.