Entur Preferences admin API
Api for creating, fetching, modifying and deleting preferences a customer can have
Api for creating, fetching, modifying and deleting preferences a customer can have
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/entur:entur-preferences-admin-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Customers Preferences admin API
description: Documentation of the Customers API
termsOfService: https://entur.org
contact:
name: Entur Team Personalisering
url: https://enturas.atlassian.net/wiki/spaces/CULP/overview
email: team.personalisering@entur.org
version: 2026.10.0
servers:
- url: https://api.entur.io/customers/v2
security:
- jwt: []
tags:
- name: Preferences admin
description: Api for creating, fetching, modifying and deleting preferences a customer can have
paths:
/preferences/{preferenceId}:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Preferences admin
summary: Find Preference by id
description: Get a specific preference by Id.
operationId: findPreferenceById
parameters:
- name: preferenceId
in: path
required: true
style: simple
explode: false
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PreferenceResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'500':
$ref: '#/components/responses/Error500'
x-entur-permissions:
value:
any:
- customers-profile:les
- customers-profile-global:les
- customers-preference:les
put:
tags:
- Preferences admin
summary: Update preference
description: Update the fields of an existing preference. All values are stored and overrides current values.
operationId: updatePreference
parameters:
- name: preferenceId
in: path
required: true
style: simple
explode: false
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreferenceRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PreferenceResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'500':
$ref: '#/components/responses/Error500'
x-entur-permissions:
value: customers-preference:endre
/preferences:
parameters:
- $ref: '#/components/parameters/ET-Client-Name'
- $ref: '#/components/parameters/X-Correlation-Id'
get:
tags:
- Preferences admin
summary: List all preferences
description: Get the list of all supported preferences. This list will include inactive preferences.
operationId: listAllPreferences
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'500':
$ref: '#/components/responses/Error500'
x-entur-permissions:
value:
any:
- customers-profile:les
- customers-profile-global:les
- customers-preference:les
post:
tags:
- Preferences admin
summary: Add preference
description: Add a preference to the database.
operationId: addPreference
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreferenceRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PreferenceResponse'
'400':
$ref: '#/components/responses/Error400'
'401':
$ref: '#/components/responses/Error401'
'403':
$ref: '#/components/responses/Error403'
'500':
$ref: '#/components/responses/Error500'
x-entur-permissions:
value: customers-preference:opprett
components:
responses:
Error400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Error401:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Error404:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Error403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
Error500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
schemas:
PreferenceResponse:
required:
- changedAt
- createdAt
- id
- isActive
- preferenceCode
- preferenceDescription
- preferenceType
type: object
properties:
changedAt:
type: string
description: When the preference was last changed. ISO 8601 date format
format: date-time
examples:
- '2019-04-05T14:30:30+02:00'
createdAt:
type: string
description: When the preference was created. ISO 8601 date format
format: date-time
examples:
- '2019-04-05T14:30:30+02:00'
id:
type: integer
description: Preference id.
format: int64
isActive:
type: boolean
description: Whether the preference is active.
preferenceCode:
maxLength: 20
type: string
description: The preference code.
preferenceDescription:
maxLength: 255
type: string
description: A description of the preference.
preferenceType:
maxLength: 20
type: string
description: Type of preference.
description: Preference
PreferenceRequest:
required:
- isActive
- preferenceCode
- preferenceDescription
- preferenceType
type: object
properties:
isActive:
type: boolean
description: Whether the preference is active.
preferenceCode:
maxLength: 20
type: string
description: The preference code.
preferenceDescription:
maxLength: 255
type: string
description: A description of the preference.
preferenceType:
maxLength: 20
type: string
description: Type of preference.
description: Preference
ErrorMessage:
required:
- errorCode
- longEnglish
- longNorwegian
- shortEnglish
- shortNorwegian
type: object
properties:
errorCode:
type: integer
description: The error code.
format: int32
longEnglish:
type: string
description: Long error message (English).
longNorwegian:
type: string
description: Long error message (Norwegian).
shortEnglish:
type: string
description: Short error message (English).
shortNorwegian:
type: string
description: Short error message (Norwegian).
description: 'An Error message. '
parameters:
ET-Client-Name:
name: ET-Client-Name
in: header
description: 'Entur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: `<company>-<application>`.'
required: false
style: simple
explode: false
schema:
type: string
X-Correlation-Id:
name: X-Correlation-Id
in: header
description: Correlation id
required: false
style: simple
explode: false
schema:
type: string
securitySchemes:
jwt:
type: http
scheme: bearer
bearerFormat: JWT