Organization

List

Required permission: ticket.agent or admin.organization

INFO

Technically, customers can only see their own organization if applicable.

GET-Request sent: /api/v1/organizations

Show response

// HTTP-Code 200 OK

[
  {
    "id": 1,
    "name": "Zammad Foundation",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "",
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2023-07-26T08:44:39.608Z",
    "updated_at": "2023-08-04T12:02:00.018Z",
    "vip": false,
    "member_ids": [
      2
    ],
    "secondary_member_ids": []
  },
  {
    "name": "Fast Lane Hardware Inc.",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "IT hardware and custom PC builds",
    "vip": false,
    "updated_by_id": 3,
    "id": 2,
    "created_by_id": 1,
    "created_at": "2023-07-26T08:44:48.617Z",
    "updated_at": "2023-08-04T12:01:44.370Z",
    "member_ids": [
      3,
      5,
      4
    ],
    "secondary_member_ids": []
  },
  {
    "name": "Joe's car parts",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "Their shipping department often needs computer spare parts as well as printers!",
    "vip": true,
    "updated_by_id": 3,
    "id": 3,
    "created_by_id": 1,
    "created_at": "2023-07-26T08:44:48.632Z",
    "updated_at": "2023-08-04T12:54:30.974Z",
    "member_ids": [
      8,
      7,
      6
    ],
    "secondary_member_ids": []
  },
  {
    "id": 4,
    "name": "Good Customer Inc.",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "Search the world's information, including webpages, images, videos and more. Good Customer has many special features to help you find exactly what you're looking for.",
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2023-07-26T08:44:48.645Z",
    "updated_at": "2023-07-26T08:44:48.645Z",
    "member_ids": [
      9
    ],
    "secondary_member_ids": []
  }
]

Show

Required permission: ticket.agent or admin.organization

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

INFO

Technically, any users in question can only see their own organization.

Show response

// HTTP-Code 200 OK

{
  "id": 2,
  "name": "Fast Lane Hardware Inc.",
  "shared": true,
  "domain": "",
  "domain_assignment": false,
  "active": true,
  "note": "IT hardware and custom PC builds",
  "vip": false,
  "updated_by_id": 3,
  "created_by_id": 1,
  "created_at": "2023-07-26T08:44:48.617Z",
  "updated_at": "2023-08-04T12:01:44.370Z",
  "member_ids": [
    3,
    5,
    4
  ],
  "secondary_member_ids": []
}

Create

Required permission: admin.organization

POST-Request sent: /api/v1/organizations

Show request/response

{
  "name": "Sample Corp.",
  "shared": false,
  "domain": "example.com",
  "domain_assignment": true,
  "active": true,
  "vip": true,
  "note": "Just a sample, aint that nice?",
  "members": [
    "olivia@example.com",
    "david@example.com"
  ]
}

Update

Required permission: admin.organization

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

Show request/response

{
  "name": "Sample Corp.",
  "shared": false,
  "domain": "",
  "domain_assignment": false,
  "active": true,
  "note": "This was a triumph - I'm making a note here - H-U-G-E success!",
  "members": [
    "olivia@example.com",
    "david@example.com"
  ]
}

Delete

Required permission: admin.organization

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

DANGER

This is a permanent removal

Please note that removing organizations cannot be undone.

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

Consider using Zammad's Data Privacy feature via UI for more control instead.

Show response

Response:

// HTTP-Code 200 OK

{}