Get a job order category group

GET 
/api/job-order-category-groups/{id}

Required permissions:

• settings.company: allows view of company job order category groups.

Here the dedicated support page.

Request

Path Parameters

id integerrequired

Possible values: Value must match regular expression [0-9]+

The ID of the job order category group to view

Query Parameters

deleted string

Possible values: [exclude, include, only]

Default value: exclude

Filter items by deletion status.

Examples:

Exclude deleted

Exclude soft-deleted records.

Example: exclude

Include deleted

Include both active and soft-deleted records.

Example: include

Only deleted

Return only soft-deleted records.

Example: only

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 requested job order category group.

application/json

Schema

Schema

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 group name

is_default booleanrequired

Whether the job order category group is the default one

deleted_at date-time

The date and time when the resource was deleted

Example (from schema)

{
  "id": 1,
  "created_at": "2025-10-28T10:23:50.157Z",
  "updated_at": "2025-10-28T10:23:50.157Z",
  "name": "Presales",
  "is_default": false,
  "deleted_at": "2025-10-28T10:23:50.157Z"
}

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"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "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...