Aha.io Paid Seat Groups API
The Paid Seat Groups API from Aha.io — 3 operation(s) for paid seat groups.
OpenAPI Specification
openapi: 3.1.0
info:
title: Aha! Account backups Paid Seat Groups API
version: 1.0.0
description: Complete API documentation for Aha! generated from actual test responses
contact:
name: Aha! Support
url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
description: Aha! API Server
variables:
account-domain:
description: Your Aha! account domain
default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Paid Seat Groups
paths:
/api/v1/paid_seat_groups:
get:
summary: List the administered paid seat groups
description: null
tags:
- Paid Seat Groups
parameters: []
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/PaidSeatGroupsGetResponse'
example:
paid_seat_groups:
- id: '354640896'
name: Group 3
administrators: []
capacity: 2
allocated_seats: 0
description:
id: '6776881149498351732'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149487500319'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149492142258'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
/api/v1/paid_seat_groups/{id}:
put:
summary: Updates the paid seat group
description: null
tags:
- Paid Seat Groups
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/PaidSeatGroupsPutResponse'
example:
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: 3
allocated_seats: 2
description:
id: '6776881149486533886'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaidSeatGroupsPostRequest'
example:
name: Group 2
capacity: 3
/api/v1/paid_seat_groups/{id}/modify_user:
post:
summary: Adds the user to the paid seat group
description: null
tags:
- Paid Seat Groups
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Id identifier
responses:
'200':
description: Successful operation
headers:
Content-Type:
description: application/json; charset=utf-8
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/PaidSeatGroupsPostResponse'
example:
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:
id: '6776881149483785369'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaidSeatGroupsPostRequest'
example:
user_id: 1049303076
remove: null
components:
schemas:
PaidSeatGroupsPutResponse:
type: object
properties:
id:
type: string
example: '572805993'
name:
type: string
example: Group 2
administrators:
type: array
items:
type: object
properties:
id:
type: string
example: '82352673'
name:
type: string
example: Bob Smith
email:
type: string
example: no-reply@aha.io
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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'
example:
- 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:
type: integer
example: 3
allocated_seats:
type: integer
example: 2
description:
type: object
properties:
id:
type: string
example: '6776881149486533886'
body:
type: string
example: ''
editor_version:
type: integer
example: 2
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
attachments:
type: array
items: {}
example:
id: '6776881149486533886'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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: 3
allocated_seats: 2
description:
id: '6776881149486533886'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
PaidSeatGroupsGetResponse:
type: object
properties:
paid_seat_groups:
type: array
items:
type: object
properties:
id:
type: string
example: '354640896'
name:
type: string
example: Group 3
administrators:
type: array
items: {}
capacity:
type: integer
example: 2
allocated_seats:
type: integer
example: 0
description:
type: object
properties:
id:
type: string
body:
type: string
editor_version:
type: string
created_at:
type: string
updated_at:
type: string
attachments:
type: string
example:
id: '6776881149498351732'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
id: '354640896'
name: Group 3
administrators: []
capacity: 2
allocated_seats: 0
description:
id: '6776881149498351732'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
example:
- id: '354640896'
name: Group 3
administrators: []
capacity: 2
allocated_seats: 0
description:
id: '6776881149498351732'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149487500319'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149492142258'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
example:
paid_seat_groups:
- id: '354640896'
name: Group 3
administrators: []
capacity: 2
allocated_seats: 0
description:
id: '6776881149498351732'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149487500319'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
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:
id: '6776881149492142258'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
PaidSeatGroupsPostResponse:
type: object
properties:
id:
type: string
example: '572805993'
name:
type: string
example: Group 2
administrators:
type: array
items:
type: object
properties:
id:
type: string
example: '82352673'
name:
type: string
example: Bob Smith
email:
type: string
example: no-reply@aha.io
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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'
example:
- 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:
type: integer
example: 20
allocated_seats:
type: integer
example: 2
description:
type: object
properties:
id:
type: string
example: '6776881149483785369'
body:
type: string
example: ''
editor_version:
type: integer
example: 2
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
attachments:
type: array
items: {}
example:
id: '6776881149483785369'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at:
type: string
example: '2019-01-01T00:00:00.000Z'
updated_at:
type: string
example: '2019-01-01T00:00:00.000Z'
example:
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:
id: '6776881149483785369'
body: ''
editor_version: 2
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
attachments: []
created_at: '2019-01-01T00:00:00.000Z'
updated_at: '2019-01-01T00:00:00.000Z'
PaidSeatGroupsPostRequest:
type: object
properties:
user_id:
type: integer
example: 1049303076
remove:
type: 'null'
example:
user_id: 1049303076
remove: null
securitySchemes:
OAuth2:
type: oauth2
description: OAuth2 authentication with bearer tokens
flows:
authorizationCode:
authorizationUrl: https://{account-domain}.aha.io/oauth/authorize
tokenUrl: https://{account-domain}.aha.io/oauth/token
scopes: {}
ApiKeyAuth:
type: http
scheme: bearer
description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys
CookieAuth:
type: apiKey
in: cookie
name: session
description: Cookie-based authentication for web browser integration