Profiles client
Api for creating, fetching, modifying and deleting customers and related information.
Find customers by parameters
A list of customers matching the search criteria. Always includes postalAddresses and personnelTickets if available.
query Parameters
firstNamesurnameemailcountryCodeIgnored unless telephoneNumberNoCountryCode is also set.
telephoneNumberIgnored if countryCode and telephoneNumberNoCountryCode are set.
telephoneNumberNoCountryCodeTelephone number with no country code prefix. Ignored unless countryCode is also set.
landlineNumberdateOfBirthpostalAddresspostCodeticketRightOwnerticketRightBearerorganisationIdmaxResultSetincludeTemporaryinvoiceOrganisationIdOrganisation ID from Brønnøysund, for invoice profiles
vippsIdVipps unique user identifier
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customers by parameters › Responses
OK
Create a customer
Creates a new customer in the database. If a customerRef is not specified, one will be assigned. The customerRef and email fields must be unique within an organisation. After the creation is complete, a CREATE event will be posted to the customer-changed queue.
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a customer › Request Body
surnameSurname.
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
organisationIdThe organisation the customer is registered with.
createdByChannelWhich sales channel or system who created the customer. Examples include web, app, crm. Used for traceability in accordance with GDPR
emailEmail used for contact and potentially also for login.
vippsIdVipps unique user identifier
passwordThe users password
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set
dateOfBirthDate of birth. ISO 8601 date format
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
customerAccountIdDeprecated. Use /profiles/{customerNumber}/customer-accounts. Customer account id used for account based ticketing
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Create a customer › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find customers by parameters, paginated
A paginated list of customers matching the search criteria. Always includes postalAddresses and personnelTickets if available.
query Parameters
firstNamesurnameemailcountryCodeIgnored unless telephoneNumberNoCountryCode is also set.
telephoneNumberIgnored if countryCode and telephoneNumberNoCountryCode are set.
telephoneNumberNoCountryCodeTelephone number with no country code prefix. Ignored unless countryCode is also set.
landlineNumberdateOfBirthpostalAddresspostCodeticketRightOwnerticketRightBearerorganisationIdincludePreferencesincludeTemporaryinvoiceOrganisationIdOrganisation ID from Brønnøysund, for invoice profiles
pageperPagesortBySort field. Allowable values are customerNumber, firstName, surname, email,dateOfBirth, organisationId
sortDirectionSort direction if sortBy is given.
vippsIdVipps unique user identifier
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customers by parameters, paginated › Responses
OK
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
Get many customers by customerNumbers
Get customer profile data for the provided customer numbers or customer references. The list is filtered based on the organisationId of the logged inn user. If both customer numbers and customer references is passed then customer numbers will be used, unless customer numbers is an empty list while customer references is a non-empty list.
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get many customers by customerNumbers › Request Body
customerNumbersCustomer numbers to look up. Max 1000 numbers at a time.
customerReferencesCustomer references (aka external references) to look up. Will not be used if non-empty list of customer numbers is provided. Max 1000 references at a time.
includePreferencesOptional flag to include profile preferences
Get many customers by customerNumbers › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find customer by UUID
Gets a customer with related information, even if this customer has been deleted (though, in this case, that is all you're told). Like in the lookup by customerNumber, if the customer has been merged into another, you will get the active customer.
path Parameters
uuidquery Parameters
includeECardsincludePersonnelTicketincludePreferencesincludeDeletedincludeNotesHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customer by UUID › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find customer by customer number
Gets a customer with related information. If the passed customer number is for a merged and passive customer, the result will instead be the active, merged customer. Thus, you may find a customer with a different customer number than you specified in the URL.
path Parameters
customerNumberquery Parameters
includeECardsincludePersonnelTicketincludePreferencesincludeDeletedincludeNotesHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customer by customer number › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Update customer
Updates a customer with the added data. If an address is not specified in the request, it will not be changed. After the update is complete, an UPDATE event will be added to the customer-changes queue.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update customer › Request Body
surnameSurname.
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
emailEmail used for contact and potentially also for login
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
vippsIdVipps unique user identifier
countryCodeTelephone number country code, starting with +.
dateOfBirthDate of birth. ISO 8601 date format
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
customerAccountIdDeprecated. The field is no longer stored. Use /profiles/{customerNumber}/customer-accounts. Customer account id used for account based ticketing.
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Update customer › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find customer by E-card number
Accepts both 16 digit and 10 digit ecard numbers. Gets a customer with related information. Like in the lookup by customerNumber, if the customer has been merged into another, you will get the active customer.
path Parameters
ecardNumberquery Parameters
includeECardsincludePersonnelTicketincludePreferencesincludeDeletedincludeNotesHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customer by E-card number › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Deactivate customer
Deactivates a customer. In practice this means mark them for deletion and set the expiration date. Another process is responsible for the actual removal from the database. While a customer is deactivated, it's still possible to look them up, by specifying the includeDeleted flag.
path Parameters
customerNumberquery Parameters
expirationDateHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Deactivate customer › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Restore deactivated customer
Restores a deactivated customer. This means reinstating the status it had before deletion. If another customer has been registered for the same organisation with the same email address since marking for deactivation, the restoration will fail.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Restore deactivated customer › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find all preferences for customer
Get all customer preferences for the given customer number.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find all preferences for customer › Responses
OK
Bulk update customer preferences
Replaces all a customers preferences with the supplied list. All existing preferences will be deleted! Use with caution.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Bulk update customer preferences › Request Body
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
Bulk update customer preferences › Responses
OK
changedAtWhen the customer preference was last changed. ISO 8601 date format
createdAtWhen the customer preference was created. ISO 8601 date format
Preference
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
customerIdId of the customer. Deprecated
Create customer preference
Create a new customer preference. This will fail if the customer already has that preference set.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create customer preference › Request Body
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
Create customer preference › Responses
OK
changedAtWhen the customer preference was last changed. ISO 8601 date format
createdAtWhen the customer preference was created. ISO 8601 date format
Preference
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
customerIdId of the customer. Deprecated
Find all E-cards for customer
Get all ecard information for the given customer.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find all E-cards for customer › Responses
OK
Add E-card to customer
Create a new E-card registration for the given customer.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Add E-card to customer › Request Body
ecardNumberEcard number.
ecardOperatorEcard operator.
startOfOwnershipWhen the ecard was first connected to the customer. ISO 8601 date format
ecardNameCustomer defined ecard alias.
bookingDateWhen the physical ecard was booked. ISO 8601 date format
shippingDateWhen the physical ecard was shipped to the customer. ISO 8601 date format
endOfOwnershipWhen the customer removed the ecard connection. ISO 8601 date format
expirationDateWhen the physical ecard expires. ISO 8601 date format
ecardNumber16digitsThe 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.
Add E-card to customer › Responses
OK
idEcard id.
changedAtWhen the ecard was last changed. ISO 8601 date format
createdAtWhen the ecard was created. ISO 8601 date format
ecardNumberEcard number.
ecardOperatorEcard operator.
startOfOwnershipWhen the ecard was first connected to the customer. ISO 8601 date format
ecardNumber16digitsThe 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.
ecardNameCustomer defined ecard alias.
bookingDateWhen the physical ecard was booked. ISO 8601 date format
shippingDateWhen the physical ecard was shipped to the customer. ISO 8601 date format
endOfOwnershipWhen the customer removed the ecard connection. ISO 8601 date format
expirationDateWhen the physical ecard expires. ISO 8601 date format
customerIdThe customer connected to the ecard. Deprecated
Create a new postal address
Create a new postal address for the customer.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Create a new postal address › Request Body
townThe address post town. Will be required
postCodeThe address post code. Only 4 digits for Norwegian addresses.
countryCodeThe address country code. ISO 3166-1 alpha-3 format
typeOfAddressThe type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.
idUnique id for postal address. This value is exclusively used when updating a full customer, to identify which of the addresses to update. Otherwise it is ignored.
verifiedAtWhen the address was verified. ISO 8601 date format
addressLine1Address line 1.
addressLine2Address line 2, often used for c/o information.
Create a new postal address › Responses
OK
idPostal address id.
townThe address post town.
postCodeThe address post code.
changedAtWhen the postal address was last changed. ISO 8601 date format
createdAtWhen the postal address was created. ISO 8601 date format
customerIdThe customer connected to the address.
countryCodeThe address country code. ISO 3166-1 alpha-3 format
typeOfAddressThe type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.
verifiedAtWhen the address was verified. ISO 8601 date format
addressLine1Address line 1.
addressLine2Address line 2, often used for c/o information.
Connect a profile to a permanent profile
Connects a profile a permanent profile. A temporary (T) or permanent (S) profile can be connected to a permanent profile (S). This is typically used when a customer has created a temporary profile to purchase a ticket, and later wants to connect this profile to their permanent profile. Both profiles need to be active.
path Parameters
customerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Connect a profile to a permanent profile › Request Body
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
customerNumberToConnectCustomer number of the profile to connect
temporaryCustomerNumberCustomer number of temporary customer to connect
Connect a profile to a permanent profile › Responses
OK
changedAtWhen the list of connected profiles was last changed. ISO 8601 date format
relatedCustomerNumbersCustomer numbers for temporary profiles that is connected to a profile
Find customer by customer reference
Gets a customer with related information. If the passed customer reference is for a merged and passive customer, the result will instead be the active, merged customer. Thus, you may find a customer with a different customer reference than you specified in the URL.
path Parameters
customerReferencequery Parameters
includeECardsincludePersonnelTicketincludePreferencesincludeDeletedincludeNotesorganisationIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find customer by customer reference › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Find a specific preference for customer
Get a specific customer preference by preference Id.
path Parameters
customerNumberpreferenceIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find a specific preference for customer › Responses
OK
changedAtWhen the customer preference was last changed. ISO 8601 date format
createdAtWhen the customer preference was created. ISO 8601 date format
Preference
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
customerIdId of the customer. Deprecated
Update a customer preference
Set a new value for a given customer preference. This will fail if the customer doesn't have this preference set already.
path Parameters
customerNumberpreferenceIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update a customer preference › Request Body
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
Update a customer preference › Responses
OK
changedAtWhen the customer preference was last changed. ISO 8601 date format
createdAtWhen the customer preference was created. ISO 8601 date format
Preference
preferenceIdId of the preference
preferenceValueValue of the preference. This can be things like membership number.
customerIdId of the customer. Deprecated
Delete a customer preference
Deletes the given customer preference from the database.
path Parameters
customerNumberpreferenceIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Delete a customer preference › Responses
No Content
Find Customer by organisation and username
Look up a customer with related information using the username for the profile. Within an organisation, email address is unique. Unlike the other lookups, this might return a passive customer or a customer created only for personnel ticket connection.
path Parameters
organisationIdusernameHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find Customer by organisation and username › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.
Update postal address
Updates an existing postal address on the customer.
path Parameters
customerNumberpostalAddressIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update postal address › Request Body
townThe address post town. Will be required
postCodeThe address post code. Only 4 digits for Norwegian addresses.
countryCodeThe address country code. ISO 3166-1 alpha-3 format
typeOfAddressThe type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.
idUnique id for postal address. This value is exclusively used when updating a full customer, to identify which of the addresses to update. Otherwise it is ignored.
verifiedAtWhen the address was verified. ISO 8601 date format
addressLine1Address line 1.
addressLine2Address line 2, often used for c/o information.
Update postal address › Responses
OK
idPostal address id.
townThe address post town.
postCodeThe address post code.
changedAtWhen the postal address was last changed. ISO 8601 date format
createdAtWhen the postal address was created. ISO 8601 date format
customerIdThe customer connected to the address.
countryCodeThe address country code. ISO 3166-1 alpha-3 format
typeOfAddressThe type of address. Types supported: 'P' = Private, 'I' = Invoice, 'S' = Shadow.
verifiedAtWhen the address was verified. ISO 8601 date format
addressLine1Address line 1.
addressLine2Address line 2, often used for c/o information.
Delete postal address
Deletes the given postal address from the customer.
path Parameters
customerNumberpostalAddressIdHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Delete postal address › Responses
No Content
Find specific E-card
Get a specific ecard by customer number and ecard information.
path Parameters
customerNumberecardOperatorecardNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Find specific E-card › Responses
OK
idEcard id.
changedAtWhen the ecard was last changed. ISO 8601 date format
createdAtWhen the ecard was created. ISO 8601 date format
ecardNumberEcard number.
ecardOperatorEcard operator.
startOfOwnershipWhen the ecard was first connected to the customer. ISO 8601 date format
ecardNumber16digitsThe 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.
ecardNameCustomer defined ecard alias.
bookingDateWhen the physical ecard was booked. ISO 8601 date format
shippingDateWhen the physical ecard was shipped to the customer. ISO 8601 date format
endOfOwnershipWhen the customer removed the ecard connection. ISO 8601 date format
expirationDateWhen the physical ecard expires. ISO 8601 date format
customerIdThe customer connected to the ecard. Deprecated
Update E-card registration
Update an existing E-card for a customer. Can also be used to set a new owner of the E-card. The internal logic is 'find the customer who owns this E-card. Then, see if this is the same customer who is specified in the URL. If it isn't, move the card to this new customer.' Regardless of whether the card is moved, all fields are overwritten with the supplied info. Also note that it isn't possible to switch the card ownership to a customer from another organisation.
path Parameters
customerNumberecardOperatorecardNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Update E-card registration › Request Body
ecardNumberEcard number.
ecardOperatorEcard operator.
startOfOwnershipWhen the ecard was first connected to the customer. ISO 8601 date format
ecardNameCustomer defined ecard alias.
bookingDateWhen the physical ecard was booked. ISO 8601 date format
shippingDateWhen the physical ecard was shipped to the customer. ISO 8601 date format
endOfOwnershipWhen the customer removed the ecard connection. ISO 8601 date format
expirationDateWhen the physical ecard expires. ISO 8601 date format
ecardNumber16digitsThe 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.
Update E-card registration › Responses
OK
idEcard id.
changedAtWhen the ecard was last changed. ISO 8601 date format
createdAtWhen the ecard was created. ISO 8601 date format
ecardNumberEcard number.
ecardOperatorEcard operator.
startOfOwnershipWhen the ecard was first connected to the customer. ISO 8601 date format
ecardNumber16digitsThe 16 digit ecard number. A combination of ecardNumber, ecardOperator and control digit.
ecardNameCustomer defined ecard alias.
bookingDateWhen the physical ecard was booked. ISO 8601 date format
shippingDateWhen the physical ecard was shipped to the customer. ISO 8601 date format
endOfOwnershipWhen the customer removed the ecard connection. ISO 8601 date format
expirationDateWhen the physical ecard expires. ISO 8601 date format
customerIdThe customer connected to the ecard. Deprecated
Merge customers
Merge a personnel ticket customer with a standard customer. Given the customer number to a profile that has been created solely for being the recipient of a personnel ticket, you can merge that profile into an active profile. In practice this deletes the personnel ticket profile and transfers any tickets onto the current profile.
path Parameters
customerNumberpticketCustomerNumberHeaders
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Merge customers › Responses
OK
uuidA universal unique id for the customer. 32 random alphanumeric characters. Not RFC 4122 compliant
statusCustomer status. Statuses supported: 'A' = Active, 'P' = Passive, 'D' = Deleted. Default is 'A'.
surnameSurname.
changedAtWhen the customer was last changed. ISO 8601 date format
changedByWho last changed the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
createdAtWhen the customer was created. ISO 8601 date format
createdByWho created the customer. Either web, app or username of employee. Used for traceability in accordance with GDPR
firstNameFirst and middle name.
profileTypeType of profile. Types supported: 'S' = Standard customer, 'P' = Personnel ticket customer, 'T' = Temporary customer. Default is 'S'.
customerNumberCustomer number.
organisationIdThe organisation the customer is registered with.
changedByChannelWhich sales channel or system who last changed the customer. Used for traceability in accordance with GDPR
createdByChannelWhich sales channel or system who created the customer. Used for traceability in accordance with GDPR
emailContact email. May become different from username
vippsIdVipps unique user identifier
emailOldWhen customer is deleted (status='D'), the value of 'email' is moved here to allow creation of a new customer with the same email.
parentIdId of the parent customer. Used to connect different customer types.
usernameUsername the customer can use to log unto their profile. Only available on profile type S(tamkunde) and profile status A(ctive)
countryCodeTelephone number country code, starting with +.
customerRefOptional customer reference. Defaults to customer number if not set.
Date as object
Date as object
nationalityThe customers nationality. ISO 3166-1 alpha-3 format
The preferences connected to the customer.
lastSignInAtWhen the customer last signed in. ISO 8601 date format
expirationDateThe date when the customers personal data should be deleted. Personal data will be deleted continuously. ISO 8601 date format
landlineNumberLandline telephone number.
lastSignInFromWhere the customer last signed in from. Typically web or app. Typically used to display to the user where the last login was performed.
The ecards connected to the customer.
emailVerifiedAtWhen the email was verified. ISO 8601 date format
The postal addresses connected to the customer.
telephoneNumberDeprecated. Please use countryCode and telephoneNumberNoCountryCode. Telephone number for customer. This should be a cell phone number.
Customer accounts used for account based ticketing
The legacy consents connected to the customer.
customerAccountIdCustomer account id used for account based ticketing
The personnel tickets connected to the customer. Deprecated. Does not contain updated information.
relatedCustomerNumbersThe customer number of profiles which has been merged into the current profile. These may be used to lookup customer information in other systems
languagePreferenceISO6393Which language the customer wants information in. ISO 639-3 format. Default is 'NOB'.
telephoneNumberVerifiedAtWhen the telephone number was verified. ISO 8601 date format
telephoneNumberNoCountryCodeTelephone number without country code or punctuation.
idCustomer id. Deprecated
Deprecated. The notes connected to the customer.
The consents connected to the customer. Deprecated
languagePreferenceDeprecated, please use languagePreferenceISO6393. Which language the customer wants information in. Default is 'NO'.