---
title: "Returns applet optin configuration"
method: GET
path: "/v1/publicapplets/{hashId}/optin/configuration"
tags: ["publicapplets"]
---

# Returns applet optin configuration

`GET /v1/publicapplets/{hashId}/optin/configuration`

## Request

- Base URL: `https://apiv1.linkmobility.eu/api`
- URL: `https://apiv1.linkmobility.eu/api/v1/publicapplets/{hashId}/optin/configuration`
- Auth: none declared

## Path parameters

- `hashId` string, required

## Response `200`

OK

- PublicAppletOptInConfigurationResponseDto
  - `defaultDiallingCode` integer: default dialling code
  - `whatsappAvailable` boolean: whatsapp available
  - `smsAvailable` boolean: sms available
  - `whatsappMsisdn` string: whatsapp msisdn
  - `companyName` string: company name
  - `components` PublicAppletOptInConfigurationComponentsResponseDto
    - `title` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `intro` PublicAppletOptInConfigurationComponentTextareaResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `contactGroups` PublicAppletOptInConfigurationComponentContactGroupsResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `minimalContactGroups` MinimalContactGroupResponse[]: contact groups
        - `id` integer, required: contact group id
        - `name` string, required: group name
    - `firstName` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `lastName` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `emailAddress` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `contactTitle` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `nickname` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `landline` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `fax` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `birthday` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `homepage` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `instantMessenger` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `skype` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `remarks` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `street` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `zipCode` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `city` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `country` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `company` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `department` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `bureau` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `position` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `jobTitle` PublicAppletOptInConfigurationComponentContactFieldResponseDto
      - `content` string: content
      - `required` boolean: required
      - `position` integer: position
    - `msisdn` PublicAppletOptInConfigurationComponentMsisdnResponseDto
      - `content` string: content
      - `position` integer: position
      - `optinChannels` string[]: opt in channels
    - `logo` PublicAppletOptInConfigurationComponentAttachmentResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `url` string: attachment url
      - `attachmentMimeType` string: attachment mime type
    - `appletTitle` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `companyName` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `labelChannelSelection` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `labelContactGroupSelection` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `labelWhatsappMsisdn` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `titleMsisdnVerificationSuccessful` PublicAppletOptInConfigurationComponentFieldResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `descriptionMsisdnVerificationSuccessful` PublicAppletOptInConfigurationComponentTextareaResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
    - `termsAndConditions` PublicAppletOptInConfigurationComponentTermsAndConditionsResponseDto
      - `visible` boolean: visible
      - `position` integer: position
      - `content` string: content
      - `required` boolean: required
  - `messages` PublicAppletOptInConfigurationMessagesResponseDto
    - `isBlacklisted` PublicAppletOptInConfigurationMessageResponseDto
      - `content` string: content
  - `kioskMode` boolean: kiosk mode

## Other responses

- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/linkmobility/apis/linkmobility-api.md) - [All operations](https://skmtc.dev/linkmobility/apis/linkmobility-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linkmobility/apis/linkmobility-api/revisions/029548691274?raw)