Skip to main content

List job order category groups

GET 
/api/job-order-category-groups

Required permissions:

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

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 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. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    Examples:

    Exclude soft-deleted records.

    Example: exclude

    deleted_at date-time

    Filter items by the deleted_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items deleted on a date.

    Example: 2024-01-01T20:00:00%2B02:00

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of job order category groups set for the company.

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

  • ]

Loading...