Group

INFO

• Please note that follow_up_possible may not work as expected. The possible values are yes or new_ticket!
• If you want to create or update subgroups, use :: as delimiter for the names. You also have to name the complete hierarchy in the name. Example: Sales::Europe::South

List

Required permission: admin.group

GET-Request sent: /api/v1/groups

Show response

// HTTP-Code 200 OK

[
  {
    "id": 1,
    "signature_id": 1,
    "email_address_id": null,
    "name": "Sales",
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": "Standard Group/Pool for Tickets.",
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:51:13.449Z",
    "updated_at": "2021-11-03T11:57:16.357Z",
    "user_ids": [
      3,
      4,
      5
    ]
  },
  {
    "id": 2,
    "signature_id": null,
    "email_address_id": null,
    "name": "Support::2nd Level",
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": null,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:57:15.802Z",
    "updated_at": "2021-11-03T11:57:16.361Z",
    "user_ids": [
      3,
      4,
      5
    ]
  },
  {
    "id": 3,
    "signature_id": null,
    "email_address_id": null,
    "name": "IT Internal",
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": null,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2021-11-03T11:57:15.807Z",
    "updated_at": "2021-11-03T11:57:16.365Z",
    "user_ids": [
      3,
      4,
      5
    ]
  }
]

Show

Required permission: admin.group

GET-Request sent: /api/v1/groups/{id}

Show response

// HTTP-Code 200 OK

{
  "id": 2,
  "signature_id": null,
  "email_address_id": null,
  "name": "2nd Level",
  "assignment_timeout": null,
  "follow_up_possible": "yes",
  "follow_up_assignment": true,
  "active": true,
  "note": null,
  "updated_by_id": 1,
  "created_by_id": 1,
  "created_at": "2021-11-03T11:57:15.802Z",
  "updated_at": "2021-11-03T11:57:16.361Z",
  "user_ids": [
    3,
    4,
    5
  ]
}

Create

Required permission: admin.group

POST-Request sent: /api/v1/groups

Show request/response

{
  "name": "Amazing Group",
  "signature_id": 1,
  "email_address_id": 3,
  "assignment_timeout": 180,
  "follow_up_possible": "new_ticket",
  "follow_up_assignment": false,
  "active": true,
  "note": "Look at my group, my group is amazing!"
}

Update

Required permission: admin.group

PUT-Request sent: /api/v1/groups/{id}

Show request/response

{
  "name": "Amazing Group",
  "signature_id": 1,
  "email_address_id": 3,
  "assignment_timeout": 0,
  "follow_up_possible": "new_ticket",
  "follow_up_assignment": true,
  "active": true,
  "note": "Look at my group, my group is amazing!"
}

Delete

Required permission: admin.group

DELETE-Request sent: /api/v1/groups/{id}

DANGER

This is a permanent removal:

Please note that removing groups cannot be undone.

Removing organizations with references in e.g. activity streams or tickets is not possible via API - this will be indicated by "error": "Can't delete, object has references.". This is not a bug.

Consider setting affected groups to inactive instead or ensure to move all existing tickets to new groups.

Show response

// HTTP-Code 200 OK

{}