# List Item Groups

Endpoint: GET /item_group
Version: v1
Security: x-api-key, A-api-key

## Query parameters:

  - `page` (integer)
    Example: 1

  - `page_size` (integer)
    Example: 50

  - `sort_by` (array)
    Comma separated search fields
    Example: ["[\"field_name\",\"field_name\"]"]

  - `q[]` (array)
    Filter result by one or more fields.

See Query Filtering

Available filters:

| Value       | Format               |
|-------------|----------------------|
| description | string   |
| archived    | boolean |

## Response 200 fields (application/json):

  - `item_groups` (array)

  - `item_groups.row_num` (integer)

  - `item_groups.total_rows` (integer)

  - `item_groups.links` (object)

  - `item_groups.links.self` (string)
    Example: "https://api.pracsuite.com/v1/item_group/1"

  - `item_groups.tenant_id` (integer)

  - `item_groups.item_group_id` (integer)

  - `item_groups.description` (string)

  - `item_groups.archived` (boolean)

  - `total_entries` (integer)

## Response 400 fields (application/json):

  - `error` (object, required)

  - `error.status` (integer, required)
    Example: 400

  - `error.code` (string, required)
    Example: "INVALID_PARAMS"

  - `error.title` (string, required)
    Example: "Invalid Params"

  - `error.detail` (string)
    Human readable explanation of the error
    Example: "One or more request parameters are invalid."

  - `request_id` (string, required)
    Example: "00000000-0000-0000-0000-000000000000"

## Response 401 fields (application/json):

  - `error` (object, required)

  - `error.status` (integer, required)
    Example: 403

  - `error.code` (string, required)
    Example: "UNAUTHORIZED"

  - `error.title` (string, required)
    Example: "Unauthorised"

  - `error.detail` (string)
    Human readable explanation of the error
    Example: "Access could not be verified for this request."

  - `request_id` (string, required)
    Example: "00000000-0000-0000-0000-000000000000"

## Response 403 fields (application/json):

  - `error` (object, required)

  - `error.status` (integer, required)
    Example: 403

  - `error.code` (string, required)
    Example: "MISSING_AUTHENTICATION_TOKEN"

  - `error.title` (string, required)
    Example: "Unauthorised"

  - `error.detail` (string)
    Human readable explanation of the error
    Example: "Authentication token is missing or the requested endpoint does not exist"

  - `request_id` (string, required)
    Example: "00000000-0000-0000-0000-000000000000"

## Response 500 fields (application/json):

  - `error` (object, required)

  - `error.status` (integer, required)
    Example: 500

  - `error.code` (string, required)
    Example: "SERVER_ERROR"

  - `error.title` (string, required)
    Example: "Server Error"

  - `error.detail` (string)
    Human readable explanation of the error
    Example: "An unexpected error occurred while processing your request. Please try again in a few minutes. If it keeps happening, contact support with Request ID: 00000000-0000-0000-0000-000000000000."

  - `request_id` (string, required)
    Example: "00000000-0000-0000-0000-000000000000"