Entur · Schema
CompanionProfile
A companion profile
CompanyPublic TransportJourney PlanningMobilityOpen DataNorwayTransitGraphQL
Properties
| Name | Type | Description |
|---|---|---|
| changed | string | Changed datetime. |
| compatibleWithVersionRef | string | Compatible with version. |
| created | string | Created datetime. |
| derivedFromVersionRef | string | Derived from version. |
| description | array | Description represented in different languages. Language codes are ISO-639. |
| discountBasis | string | Basis for discount. |
| fareFrameRef | object | |
| fareTableRefs | array | References to fare tables that provide prices or discounts for the companion profile. |
| generalGroupOfEntities | object | |
| id | string | Id. |
| limitingRuleRef | object | |
| maximumNumberOfPersons | integer | Maximum number of allowed companions. |
| minimumNumberOfPersons | integer | Minimum number of allowed companions. |
| modification | string | Modification status. |
| name | array | The name of the companion profile represented in different languages. Language codes are ISO-639. |
| nameOfClass | string | Name of class. |
| parentRef | object | |
| prices | array | Fare prices for the companion profile. |
| status | string | Status |
| ticketing | string | The type of way that tickets are issued to the group. |
| typeOfUsageParameter | string | typeOfUsageParameter. |
| userProfileId | string | A user profile defining a category of people eligible to be a companion. |
| userProfileRef | object | |
| validityConditions | array | Validity conditions for the companion profile. |
| version | string | The version of the companion profile. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/entur/json-schema/entur-companion-profile-schema.json",
"title": "CompanionProfile",
"description": "A companion profile",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/entur-companion-profiles-api-openapi.yml#/components/schemas/CompanionProfile",
"required": [
"changed",
"created",
"fareFrameRef",
"id",
"modification",
"nameOfClass",
"status",
"version"
],
"type": "object",
"properties": {
"changed": {
"type": "string",
"description": "Changed datetime.",
"format": "date-time"
},
"compatibleWithVersionRef": {
"type": "string",
"description": "Compatible with version."
},
"created": {
"type": "string",
"description": "Created datetime.",
"format": "date-time"
},
"derivedFromVersionRef": {
"type": "string",
"description": "Derived from version."
},
"description": {
"type": "array",
"description": "Description represented in different languages. Language codes are ISO-639.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"discountBasis": {
"type": "string",
"description": "Basis for discount.",
"enum": [
"NONE",
"FREE",
"DISCOUNT",
"FULLRATE"
]
},
"fareFrameRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"fareTableRefs": {
"type": "array",
"description": "References to fare tables that provide prices or discounts for the companion profile.",
"items": {
"$ref": "#/$defs/VersionOfObjectRef"
}
},
"generalGroupOfEntities": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"id": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Id."
},
"limitingRuleRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"maximumNumberOfPersons": {
"type": "integer",
"description": "Maximum number of allowed companions.",
"format": "int32"
},
"minimumNumberOfPersons": {
"type": "integer",
"description": "Minimum number of allowed companions.",
"format": "int32"
},
"modification": {
"type": "string",
"description": "Modification status.",
"enum": [
"NEW",
"REVISE",
"DELETE"
]
},
"name": {
"type": "array",
"description": "The name of the companion profile represented in different languages. Language codes are ISO-639.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"nameOfClass": {
"type": "string",
"description": "Name of class."
},
"parentRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"prices": {
"type": "array",
"description": "Fare prices for the companion profile.",
"items": {
"$ref": "#/$defs/FarePrice"
}
},
"status": {
"type": "string",
"description": "Status",
"enum": [
"DRAFT",
"PROPOSED",
"VERSIONED",
"DEPRECATED"
]
},
"ticketing": {
"type": "string",
"description": "The type of way that tickets are issued to the group.",
"deprecated": true,
"enum": [
"ALL_ON_ONE_TICKET",
"SEPARATE_TICKETS",
"TICKET_WITH_COUPONS",
"OTHER"
]
},
"typeOfUsageParameter": {
"type": "string",
"description": "typeOfUsageParameter."
},
"userProfileId": {
"type": "string",
"description": "A user profile defining a category of people eligible to be a companion."
},
"userProfileRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"validityConditions": {
"type": "array",
"description": "Validity conditions for the companion profile.",
"items": {
"$ref": "#/$defs/ValidityCondition"
}
},
"version": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "The version of the companion profile."
}
},
"$defs": {
"FarePrice": {
"required": [
"changed",
"created",
"fareFrameRef",
"id",
"modification",
"nameOfClass",
"status"
],
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Amount"
},
"canBeCumulative": {
"type": "boolean",
"description": "canBeCumulative."
},
"changed": {
"type": "string",
"description": "Changed datetime.",
"readOnly": true
},
"compatibleWithVersionRef": {
"type": "string",
"description": "Compatible with version."
},
"created": {
"type": "string",
"description": "Created datetime.",
"readOnly": true
},
"currency": {
"type": "string",
"description": "Currency."
},
"derivedFromVersionRef": {
"type": "string",
"description": "Derived from version."
},
"discountPercentageUsed": {
"maximum": 100,
"minimum": -100,
"type": "integer",
"description": "discountPercentageUsed.",
"format": "int32"
},
"fareFrameRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"id": {
"minLength": 1,
"type": "string",
"description": "Id."
},
"isAllowed": {
"type": "boolean",
"description": "isAllowed."
},
"limitingRule": {
"$ref": "#/$defs/LimitingRule"
},
"modification": {
"type": "string",
"description": "Modification status.",
"readOnly": true,
"enum": [
"NEW",
"REVISE",
"DELETE"
]
},
"name": {
"type": "array",
"description": "Name.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"nameOfClass": {
"type": "string",
"description": "Name of class.",
"readOnly": true
},
"ranking": {
"type": "integer",
"description": "Ranking.",
"format": "int32"
},
"rounding": {
"$ref": "#/$defs/Rounding"
},
"roundingRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"status": {
"type": "string",
"description": "Status.",
"readOnly": true,
"enum": [
"DRAFT",
"PROPOSED",
"VERSIONED",
"DEPRECATED"
]
},
"vatRegisterGroup": {
"type": "string",
"description": "vatRegisterGroup.",
"enum": [
"EXCEPTION_FROM_VAT",
"GENERAL_VAT",
"FOOD_VAT",
"TRANSPORT_AND_TICKETS_VAT"
]
},
"version": {
"type": "string",
"description": "Version.",
"readOnly": true
}
},
"description": "A description of the price and factor for a set fare"
},
"LimitingRule": {
"required": [
"changed",
"created",
"fareFrameRef",
"id",
"modification",
"nameOfClass",
"status"
],
"type": "object",
"properties": {
"canBeCumulative": {
"type": "boolean",
"description": "CanBeCumulative."
},
"changed": {
"type": "string",
"description": "Changed datetime.",
"readOnly": true
},
"compatibleWithVersionRef": {
"type": "string",
"description": "Compatible with version."
},
"created": {
"type": "string",
"description": "Created datetime.",
"readOnly": true
},
"derivedFromVersionRef": {
"type": "string",
"description": "Derived from version."
},
"description": {
"type": "array",
"description": "Description.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"discountAsPercentage": {
"type": "number",
"description": "DiscountAsPercentage.",
"format": "float"
},
"discountAsValue": {
"type": "number",
"description": "DiscountAsValue.",
"format": "float"
},
"fareFrameRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"id": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Id."
},
"maximumPrice": {
"type": "string",
"description": "MaximumPrice."
},
"maximumPriceAsPercentage": {
"type": "number",
"description": "MaximumPriceAsPercentage.",
"format": "double"
},
"minimumLimitPrice": {
"type": "string",
"description": "MinimumLimitPrice."
},
"minimumPrice": {
"type": "string",
"description": "MinimumPrice."
},
"modification": {
"type": "string",
"description": "Modification status.",
"readOnly": true,
"enum": [
"NEW",
"REVISE",
"DELETE"
]
},
"name": {
"type": "array",
"description": "Name.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"nameOfClass": {
"type": "string",
"description": "Name of class.",
"readOnly": true
},
"status": {
"type": "string",
"description": "Status.",
"readOnly": true,
"enum": [
"DRAFT",
"PROPOSED",
"VERSIONED",
"DEPRECATED"
]
},
"version": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Version."
}
},
"description": "A LimitingRule"
},
"Rounding": {
"required": [
"changed",
"created",
"fareFrameRef",
"id",
"modification",
"nameOfClass",
"roundingMethod",
"status",
"version"
],
"type": "object",
"properties": {
"changed": {
"type": "string",
"description": "Changed datetime.",
"readOnly": true
},
"compatibleWithVersionRef": {
"type": "string",
"description": "Compatible with version."
},
"created": {
"type": "string",
"description": "Created datetime.",
"readOnly": true
},
"derivedFromVersionRef": {
"type": "string",
"description": "Derived from version."
},
"description": {
"type": "array",
"description": "Description.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"fareFrameRef": {
"$ref": "#/$defs/VersionOfObjectRef"
},
"id": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Id."
},
"modification": {
"type": "string",
"description": "Modification status.",
"readOnly": true,
"enum": [
"NEW",
"REVISE",
"DELETE"
]
},
"name": {
"type": "array",
"description": "Name.",
"items": {
"$ref": "#/$defs/TextInLanguage"
}
},
"nameOfClass": {
"type": "string",
"description": "Name of class.",
"readOnly": true
},
"roundingMethod": {
"type": "string",
"description": "Type of rounding.",
"enum": [
"NONE",
"DOWN",
"UP",
"SPLIT",
"STEP_TABLE",
"FIVE",
"NINE",
"TEN",
"FORTY_NINE"
]
},
"roundingModulus": {
"type": "number",
"description": "Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.",
"format": "double"
},
"status": {
"type": "string",
"description": "Rounding status.",
"readOnly": true,
"enum": [
"DRAFT",
"PROPOSED",
"VERSIONED",
"DEPRECATED"
]
},
"version": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Rounding version."
}
},
"description": "A description of how prices are rounded post calculation",
"deprecated": true
},
"TextInLanguage": {
"required": [
"lang",
"value"
],
"type": "object",
"properties": {
"lang": {
"minLength": 1,
"type": "string",
"description": "Language code."
},
"value": {
"minLength": 1,
"type": "string",
"description": "The text."
}
},
"description": "Text in a specific language."
},
"ValidityCondition": {
"required": [
"changed",
"created",
"id",
"modification",
"nameOfClass",
"status",
"version"
],
"type": "object",
"properties": {
"changed": {
"type": "string",
"description": "Changed datetime.",
"readOnly": true
},
"created": {
"type": "string",
"description": "Created datetime.",
"readOnly": true
},
"fromDate": {
"type": "string",
"description": "From Date."
},
"id": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Id."
},
"modification": {
"type": "string",
"description": "Modification status.",
"readOnly": true,
"enum": [
"NEW",
"REVISE",
"DELETE"
]
},
"nameOfClass": {
"type": "string",
"description": "Name of class.",
"readOnly": true
},
"status": {
"type": "string",
"description": "Status.",
"readOnly": true,
"enum": [
"DRAFT",
"PROPOSED",
"VERSIONED",
"DEPRECATED"
]
},
"toDate": {
"type": "string",
"description": "To Date."
},
"version": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "Version."
}
},
"description": "A condition of the validity of the priceable object"
},
"VersionOfObjectRef": {
"required": [
"nameOfClass",
"ref",
"version"
],
"type": "object",
"properties": {
"nameOfClass": {
"minLength": 1,
"type": "string",
"description": "Name of class."
},
"ref": {
"minLength": 1,
"pattern": "^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\\-]*)$",
"type": "string",
"description": "The netex id reference to the object."
},
"version": {
"type": "string",
"description": "Version."
}
},
"description": "Fare frame ref."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/entur-companion-profile"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.