List job order categories

GET 
/api/job-order-categories

Required permissions:

• settings.company: allows view of company job order categories.

Here the dedicated support page.

Request

Query Parameters

limit integer

Possible values: >= 1 and <= 100

Default value: 100

The number of items to include in the response.

offset integer

Default value: 0

The offset of the first returned item.

updated_at date-time

Filter items by the updated_at field.

Operators:

Equal

Usage: eq:{value}

Not equal

Usage: neq:{value}

Greater than

Usage: gt:{value}

Greater than or equal

Usage: gte:{value}

Less than

Usage: lt:{value}

Less than or equal

Usage: lte:{value}

In list

Usage: in:{value_1},{value_2},{value_3}

Not in list

Usage: nin:{value_1},{value_2},{value_3}

Between

Description: The given values are inclusive.

Usage: bt:{value_min},{value_max}

deleted string

Possible values: [exclude, include, only]

Default value: exclude

Filter items by deletion status.

deleted_at date-time

Filter items by the deleted_at field.

Operators:

Equal

Usage: eq:{value}

Not equal

Usage: neq:{value}

Greater than

Usage: gt:{value}

Greater than or equal

Usage: gte:{value}

Less than

Usage: lt:{value}

Less than or equal

Usage: lte:{value}

In list

Usage: in:{value_1},{value_2},{value_3}

Not in list

Usage: nin:{value_1},{value_2},{value_3}

Between

Description: The given values are inclusive.

Usage: bt:{value_min},{value_max}

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the list of job order categories set for the company.

application/json

Schema

Schema

• Array [

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

Possible values: <= 50 characters

The job order category name

color stringrequired

Possible values: <= 50 characters

The job order category RGB color

is_chargeable booleanrequired

Whether the job order category is chargeable

is_allocation_request_required booleanrequired

Whether plannings on projects with this job order category must be approved

is_planning_allowed_to_everybody booleanrequired

Whether everybody can plan projects with this job order category, regardless of their permissions

is_planning_unlimited booleanrequired

Whether projects with this job order category have unlimited planning

hours_type string

The type of hours worked on projects with this job order category

is_program_required booleanrequired

Whether projects with this job order category must be in a program

is_budget_invoice_driven booleanrequired

Whether projects with this job order category use invoice-driven budget

is_capex booleanrequired

Whether projects with this job order category are capex

external_costs_type stringrequired

Possible values: [on-goods-sold, before-contribution-margin, on-g-and-a, on-marketing]

The type of external costs for projects with this job order category

is_won_lost_feedback_required booleanrequired

Whether projects with this job order category track won/lost feedback

is_opportunity_status_tracking_enabled booleanrequired

Whether projects with this job order category track opportunity status

is_timesheet_automatic booleanrequired

Whether projects with this job order category use automatic timesheets

is_external_drive_canvas_enabled booleanrequired

Whether projects with this job order category use external drive canvas

project_status_mode stringrequired

Possible values: [remaining-days, percentage, time-based, timesheet-based]

The project status mode for projects with this job order category

is_project_review_required booleanrequired

Whether projects with this job order category require a review after being archived

project_review_value_threshold integer

The minimum project value in K to require a review after being archived

job_order_category_group_id integerrequired

The ID of the job order category group

job_order_template_id integer

The ID of the job order template

deleted_at date-time

The date and time when the resource was deleted

• ]

Example (from schema)

[
  {
    "id": 1,
    "created_at": "2026-03-27T11:39:29.049Z",
    "updated_at": "2026-03-27T11:39:29.049Z",
    "name": "Development",
    "color": "rgb(255, 0, 0)",
    "is_chargeable": true,
    "is_allocation_request_required": false,
    "is_planning_allowed_to_everybody": false,
    "is_planning_unlimited": false,
    "hours_type": "workable",
    "is_program_required": false,
    "is_budget_invoice_driven": true,
    "is_capex": false,
    "external_costs_type": "on-goods-sold",
    "is_won_lost_feedback_required": false,
    "is_opportunity_status_tracking_enabled": false,
    "is_timesheet_automatic": false,
    "is_external_drive_canvas_enabled": true,
    "project_status_mode": "time-based",
    "is_project_review_required": false,
    "project_review_value_threshold": 50,
    "job_order_category_group_id": 1,
    "job_order_template_id": 1,
    "deleted_at": "2026-03-27T11:39:29.049Z"
  }
]

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...