Paid Seat Groups

List the administered paid seat groups

get/paid_seat_groups

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

Successful operation

Example response

{
  "paid_seat_groups": [
    {
      "id": "354640896",
      "name": "Group 3",
      "administrators": [],
      "capacity": 2,
      "allocated_seats": 0,
      "description": null,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "572805993",
      "name": "Group 2",
      "administrators": [
        {
          "id": "82352673",
          "name": "Bob Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "capacity": 20,
      "allocated_seats": 2,
      "description": null,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "992805589",
      "name": "Group 1",
      "administrators": [
        {
          "id": "373433676",
          "name": "Jim Jingles",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "capacity": 21,
      "allocated_seats": 1,
      "description": null,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.