The Group API from Smart Pension — 2 operation(s) for group.
openapi: 3.2.0
info:
title: Keystone Group API
version: v12
description: This is the endpoint description of Keystone API.
servers:
- url: https://api.sandbox.autoenrolment.co.uk
- url: /
tags:
- name: Group
paths:
/companies/{company_id}/groups:
post:
summary: Companies/Groups/Create
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: company_id
in: path
required: true
example: 1115
schema:
type: string
requestBody:
content:
application/json:
examples:
valid_parameters:
value:
name: Managers
invalid_parameters:
value:
name: ' '
schema:
type: object
properties:
name:
type: string
maximum: 115
employee_percentage:
type: number
company_percentage:
type: number
payment_frequency:
type: string
enum:
- annually
- weekly
- fortnightly
- four_weekly
- monthly
- quarterly
- bi_annually
include_in_payment_schedule:
type: boolean
enum:
- true
- false
required:
- name
responses:
'201':
description: Success
content:
application/json:
example:
id: 2
name: Managers
company_id: 1115
employee_ids: []
created_at: '2026-08-05T13:03:27.000+01:00'
updated_at: '2026-08-05T13:03:27.000+01:00'
payment_frequency: null
employee_percentage: null
company_percentage: null
include_in_payment_schedule: false
links:
- rel: company
title: company
href: https://api.host.com/companies/1115
schema:
$ref: '#/components/schemas/response_group'
'403':
description: Company already has maximum number of groups allowed
content:
application/json:
example:
errors:
- code: 35
title: Maximum number of groups reached!
detail: You cannot have more than 5 groups.
form: null
attribute: base
error: out_of_limit
meta:
limit: 5
entity: groups
source:
pointer: /base
'422':
description: Invalid parameters
content:
application/json:
example:
errors:
- code: 1101
title: Group name is required.
detail: You need to enter a name for the group so you can identify the different groups of employees within your company.
meta: {}
source:
pointer: /data/attributes/name
get:
summary: Companies/Groups/List
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: company_id
in: path
required: true
example: 1121
schema:
type: string
- name: limit
in: query
schema:
type: integer
required: false
- name: offset
in: query
schema:
type: integer
required: false
- name: sort
in: query
schema:
type: string
required: false
- name: direction
in: query
schema:
type: string
enum:
- ASC
- DESC
required: false
- name: filter
in: query
schema:
type: object
properties:
name:
type: array
items:
type: string
include_in_payment_schedule:
type: array
items:
type: boolean
required: false
style: deepObject
- name: operator
in: query
schema:
type: string
enum:
- or
- and
required: false
responses:
'200':
description: Success
content:
application/json:
example:
limit: 50
offset: 0
total: 2
links:
- rel: self
title: self
href: http://api.host.com/companies/1121/groups
- rel: first
title: first
href: http://api.host.com/companies/1121/groups?offset=0&limit=50
- rel: last
title: last
href: http://api.host.com/companies/1121/groups?offset=0&limit=50
groups:
- id: 11
name: Managers
company_id: 1121
employee_ids: []
created_at: '2026-08-05T13:03:29.000+01:00'
updated_at: '2026-08-05T13:03:29.000+01:00'
payment_frequency: null
employee_percentage: null
company_percentage: null
include_in_payment_schedule: false
links:
- rel: company
title: company
href: https://api.host.com/companies/1121
- id: 12
name: Sales
company_id: 1121
employee_ids: []
created_at: '2026-08-05T13:03:29.000+01:00'
updated_at: '2026-08-05T13:03:29.000+01:00'
payment_frequency: null
employee_percentage: null
company_percentage: null
include_in_payment_schedule: false
links:
- rel: company
title: company
href: https://api.host.com/companies/1121
schema:
$ref: '#/components/schemas/response_group'
/companies/{company_id}/groups/{id}:
delete:
summary: Companies/Groups/Destroy
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: company_id
in: path
required: true
example: 1118
schema:
type: string
- name: id
in: path
required: true
example: 8
schema:
type: string
responses:
'204':
description: Success
get:
summary: Companies/Groups/Get
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: id
in: path
required: true
example: 9
schema:
type: string
- name: company_id
in: path
required: true
example: 1119
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
id: 9
name: default
company_id: 1119
employee_ids: []
created_at: '2026-08-05T13:03:28.000+01:00'
updated_at: '2026-08-05T13:03:28.000+01:00'
payment_frequency: null
employee_percentage: null
company_percentage: null
include_in_payment_schedule: false
links:
- rel: company
title: company
href: https://api.host.com/companies/1119
schema:
$ref: '#/components/schemas/response_group'
'404':
description: Not Found
content:
application/json:
example: ''
put:
summary: Companies/Groups/Update
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: company_id
in: path
required: true
example: 1122
schema:
type: string
- name: id
in: path
required: true
example: 13
schema:
type: string
requestBody:
content:
application/json:
examples:
valid_parameters:
value:
name: HR Managers
invalid_parameters:
value:
name: ' '
schema:
type: object
properties:
name:
type: string
maximum: 115
employee_percentage:
type: number
company_percentage:
type: number
payment_frequency:
type: string
enum:
- annually
- weekly
- fortnightly
- four_weekly
- monthly
- quarterly
- bi_annually
include_in_payment_schedule:
type: boolean
enum:
- true
- false
required:
- name
responses:
'204':
description: Success
'422':
description: Invalid parameters
content:
application/json:
example:
errors:
- code: 1101
title: Group name is required.
detail: You need to enter a name for the group so you can identify the different groups of employees within your company.
meta: {}
source:
pointer: /data/attributes/name
patch:
summary: Companies/Groups/Update
tags:
- Group
security:
- oAuth2:
- customer
parameters:
- name: company_id
in: path
required: true
example: 1124
schema:
type: string
- name: id
in: path
required: true
example: 15
schema:
type: string
requestBody:
content:
application/json:
examples:
valid_parameters:
value:
name: HR Managers
invalid_parameters:
value:
name: ' '
schema:
type: object
properties:
name:
type: string
maximum: 115
employee_percentage:
type: number
company_percentage:
type: number
payment_frequency:
type: string
enum:
- annually
- weekly
- fortnightly
- four_weekly
- monthly
- quarterly
- bi_annually
include_in_payment_schedule:
type: boolean
enum:
- true
- false
required:
- name
responses:
'204':
description: Success
'422':
description: Invalid parameters
content:
application/json:
example:
errors:
- code: 1101
title: Group name is required.
detail: You need to enter a name for the group so you can identify the different groups of employees within your company.
meta: {}
source:
pointer: /data/attributes/name
components:
schemas:
response_band:
type: object
properties:
id:
type: integer
employee_minimum_percentage:
type: number
format: float
employee_maximum_percentage:
type:
- number
- 'null'
format: float
employer_percentage:
type: number
format: float
starts_on:
type: string
format: date
ends_on:
type: string
format: date
range_min:
type:
- integer
- 'null'
range_max:
type:
- integer
- 'null'
default:
type: boolean
response_scheme_contribution_limit:
type: object
properties:
minimum_one_off_contribution_amount:
type: number
format: float
minimum_one_off_contribution_amount_currency:
type: string
maximum_one_off_contribution_amount:
type: number
format: float
maximum_one_off_contribution_amount_currency:
type: string
minimum_recurring_contribution_amount:
type: number
format: float
minimum_recurring_contribution_amount_currency:
type: string
response_adviser:
type: object
properties:
intercom_user_id:
type:
- string
- 'null'
intercom_user_id_hash:
type:
- string
- 'null'
id:
type: integer
name:
type:
- string
- 'null'
type:
type:
- string
- 'null'
address:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
signup_start:
type:
- string
- 'null'
format: text
signup_finish:
type:
- string
- 'null'
format: text
agent_number:
type:
- string
- 'null'
broker_channel:
type:
- string
- 'null'
broker_role:
type:
- string
- 'null'
abilities:
type:
- array
- 'null'
items: {}
companies:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
companies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_company'
imports:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_adviser_import'
company_tax_reliefs:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_company_tax_relief'
shortcut:
$ref: '#/components/schemas/response_adviser_shortcut'
response_salary:
type: object
properties:
annual_earnings_1:
type:
- number
- 'null'
format: float
annual_earnings_2:
type:
- number
- 'null'
format: float
created_at:
type: string
format: date-time
effective_on:
type: string
format: date
employee_id:
type: integer
id:
type: integer
updated_at:
type: string
format: date-time
employee:
$ref: '#/components/schemas/response_employee'
response_company_automation:
type: object
properties:
id:
type: integer
letter:
type: boolean
company_id:
type: integer
postponement_period:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
links:
type: array
items:
$ref: '#/components/schemas/link'
response_know_your_customer_data:
type: object
properties:
id:
type: integer
state:
type: string
reference:
type:
- string
- 'null'
response_ultimate_beneficial_owner_configuration:
type: object
properties:
id:
type: integer
company_id:
type: integer
exempt:
type: boolean
exemption_reason:
type:
- string
- 'null'
natural_person_ubo:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/link'
response_adviser_company:
type: object
properties:
id:
type: integer
adviser_id:
type: integer
company_id:
type: integer
preferred_contact_user_id:
type:
- integer
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
response_customer:
type: object
properties:
intercom_user_id:
type:
- string
- 'null'
intercom_user_id_hash:
type:
- string
- 'null'
id:
type: integer
email:
type:
- string
- 'null'
reset_password_sent_at:
type:
- string
- 'null'
format: date-time
remember_created_at:
type:
- string
- 'null'
format: date-time
last_sign_in_at:
type:
- string
- 'null'
format: date-time
slug:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
gauth_enabled:
type: boolean
gauth_tmp:
type:
- string
- 'null'
forename:
type:
- string
- 'null'
surname:
type:
- string
- 'null'
title:
type:
- string
- 'null'
authentication_token:
type:
- string
- 'null'
date_of_birth:
type:
- string
- 'null'
format: date
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
county:
type:
- string
- 'null'
building_name:
type:
- string
- 'null'
postcode:
type:
- string
- 'null'
line1:
type:
- string
- 'null'
building_number:
type:
- string
- 'null'
telephone:
type:
- string
- 'null'
alternative_telephone:
type:
- string
- 'null'
referee_id:
type:
- integer
- 'null'
referee_type:
type:
- string
- 'null'
referral_state:
type: string
referral_clicks:
type:
- integer
- 'null'
referral_reward_name:
type:
- string
- 'null'
authentication_token_generated_at:
type:
- string
- 'null'
format: date-time
gender:
type:
- string
- 'null'
role:
type:
- string
- 'null'
middlename:
type:
- string
- 'null'
envelope_state:
type: string
enforce_password:
type:
- boolean
- 'null'
company_id:
type:
- integer
- 'null'
country_code:
type:
- string
- 'null'
uuid:
type: string
preferred_locale:
type:
- string
- 'null'
smart_analytics_access_permitted:
type:
- boolean
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
company:
$ref: '#/components/schemas/response_company'
employee:
$ref: '#/components/schemas/response_employee'
shortcut:
$ref: '#/components/schemas/response_customer_shortcut'
marketing_preference:
$ref: '#/components/schemas/response_marketing_preference'
response_payment:
type: object
properties:
id:
type: integer
state:
type: string
amount:
type:
- number
- 'null'
format: float
description:
type:
- string
- 'null'
invoice_name:
type:
- string
- 'null'
paid_at:
type:
- string
- 'null'
format: date-time
charge_on:
type:
- string
- 'null'
format: date
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
invoice_url:
type:
- string
- 'null'
invoice_details_url:
type:
- string
- 'null'
invoice_details_file_name:
type:
- string
- 'null'
source_of_funds:
type:
- string
- 'null'
response_employee_plan_participation:
type: object
properties:
id:
type: integer
in_waiting_period:
type:
- boolean
- 'null'
next_state:
type:
- string
- 'null'
updated_at:
type: string
format: date-time
state:
type: string
response_letter:
type: object
properties:
id:
type: integer
subject:
type:
- string
- 'null'
name:
type:
- string
- 'null'
employee_id:
type:
- integer
- 'null'
read:
type:
- boolean
- 'null'
file_url:
type:
- string
- 'null'
file_file_name:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
cancelled_at:
type:
- string
- 'null'
format: date-time
created_by_id:
type:
- integer
- 'null'
created_by_type:
type:
- string
- 'null'
send_employee_temporary_password_notification:
type:
- boolean
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
employee:
$ref: '#/components/schemas/response_employee'
response_base_payroll_configuration:
type: object
properties:
id:
type: integer
company_id:
type: integer
description:
type:
- string
- 'null'
frequency:
type: string
name:
type: string
salary_rate:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
uuid:
type: string
links:
type: array
items:
$ref: '#/components/schemas/link'
response_company_tax_relief:
type: object
properties:
id:
type: integer
basis_type:
type: string
response_beneficiary:
type: object
properties:
id:
type: integer
title:
type: string
name:
type: string
email:
type:
- string
- 'null'
address:
type: string
postcode:
type:
- string
- 'null'
relation:
type: string
percentage:
type: number
format: float
born_on:
type: string
format: date
type:
type: string
response_benefit_check_result:
type: object
properties:
id:
type: integer
benefit_id:
type: integer
state:
type: string
redirect_url:
type:
- string
- 'null'
has_redirect_url:
type:
- boolean
- 'null'
returned_back_at:
type:
- string
- 'null'
format: date-time
comment:
type:
- string
- 'null'
format: text
automated_checks_available:
type: boolean
response_provider_scheme_migration:
type: object
properties:
id:
type: integer
state:
type: string
response_valuation:
type: object
properties:
id:
type: integer
amount:
type:
- number
- 'null'
format: float
calculated_on:
type: string
format: date
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
response_adviser_import:
type: object
properties:
id:
type: integer
status_code:
type:
- integer
- 'null'
state:
type: string
response_errors:
type:
- array
- 'null'
items: {}
file_url:
type:
- string
- 'null'
file_file_name:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
type:
type:
- string
- 'null'
metadata:
type:
- object
- 'null'
success_row_count:
type:
- integer
- 'null'
fail_row_count:
type:
- integer
- 'null'
adviser_id:
type: integer
links:
type: array
items:
$ref: '#/components/schemas/link'
adviser:
$ref: '#/components/schemas/response_adviser'
response_benefit_group:
type: object
properties:
id:
type: integer
name:
type: string
employee_contribution_holiday_permitted:
type: boolean
company_contribution_holiday_permitted:
type: boolean
band_range_type:
type:
- string
- 'null'
employer_earnings_type:
type: string
employee_earnings_type:
type: string
employer_salary_cap:
type:
- number
- 'null'
format: float
employee_salary_cap:
type:
- number
- 'null'
format: float
voluntary_enrolment:
type: boolean
profit_share_allowed:
type: boolean
contribution_match_type:
type:
- string
- 'null'
stop_contributions_permitted:
type: boolean
national_insurance_saving_share:
type:
- number
- 'null'
format: float
enrolment_type:
type:
- string
- 'null'
bands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_band'
response_scheme_tax_relief:
type: object
properties:
id:
type: integer
basis_type:
type: string
response_scheme_bank_detail:
type: object
properties:
account_number:
type:
- string
- 'null'
bank_name:
type: string
swift_code:
type: string
in_favor_of:
type: string
currency:
type:
- string
- 'null'
exchange_rate:
type:
- number
- 'null'
format: float
response_adviser_shortcut:
type: object
properties:
id:
type: integer
token:
type:
- string
- 'null'
destination_url:
type:
- string
- 'null'
short_url:
type:
- string
- 'null'
response_employee_configuration:
type: object
properties:
benefits_out_suspended:
type: boolean
disabled_switching:
type:
- boolean
- 'null'
enable_auto_increase_percentage:
type: boolean
gone_away:
type: boolean
id:
type: integer
investments_locked:
type: boolean
valuation_under_review:
type:
- boolean
- 'null'
preferred_currency:
type:
- string
- 'null'
preferred_locale:
type:
- string
- 'null'
blocked_rejoin:
type: boolean
response_employee:
type: object
properties:
updatable:
type:
- boolean
- 'null'
id:
type: integer
email:
type:
- string
- 'null'
forename:
type:
- string
- 'null'
surname:
type:
- string
- 'null'
date_of_birth:
type:
- string
- 'null'
format: date
national_insurance_number:
type:
- string
- 'null'
gender:
type: string
telephone:
type:
- string
- 'null'
identity_person_id:
type:
- string
- 'null'
reset_password_sent_at:
type:
- string
- 'null'
format: date-time
remember_created_at:
type:
- string
- 'null'
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smart-pension/refs/heads/main/openapi/smart-pension-group-api-openapi.yml