Examples

GET /api/job_templates
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1007982065,
      "name": "Job template 231",
      "job_category": "Job name 235",
      "provider_type": "SSH",
      "snippet": false,
      "description_format": null,
      "created_at": "2023-11-27 20:15:29 UTC",
      "updated_at": "2023-11-27 20:15:29 UTC"
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.