---
title: "GET /api/v1.0/app/{appId}/address/form"
method: GET
path: "/api/v1.0/app/{appId}/address/form"
tags: ["Address"]
---

# GET /api/v1.0/app/{appId}/address/form

`GET /api/v1.0/app/{appId}/address/form`

## Request

- Base URL: `https://api.flipdish.co`
- URL: `https://api.flipdish.co/api/v1.0/app/{appId}/address/form`
- Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`)

## Path parameters

- `appId` string, required

## Query parameters

- `language` string

## Response `200`

OK

- RestApiResultAddressFormResponse: Rest api result
  - `Data` AddressFormResponse, required: A response of a dyanmic form definition.
    - `FormData` DynamicFormField[]: List of field definitions.
      - `Identifier` string
      - `Label` string
      - `Placeholder` string
      - `Rules` DynamicFormRules
        - `MaxLength` DynamicFormRule
          - `Value` object
          - `Message` string
          - `Scopes` string
        - `MinLength` DynamicFormRule
          - `Value` object
          - `Message` string
          - `Scopes` string
        - `Required` DynamicFormRule
          - `Value` object
          - `Message` string
          - `Scopes` string
        - `Pattern` DynamicFormRule
          - `Value` object
          - `Message` string
          - `Scopes` string
        - `Predefined` DynamicFormFieldOption[]
          - `Display` string
          - `Value` string
      - `Mapping` object
      - `Modifiers` string[]
      - `Value` object
      - `Scopes` string
    - `CountryCode` string: ISO two letter code.
    - `Language` string: ISO culture code.
    - `DisplayFormat` AddressFormDisplayFormat
      - `OneLine` string
      - `TwoLines` string[]

## Other responses

- `400`: BadRequest
- `401`: Authentication has been denied for this request.
- `403`: Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/ec0c138b13ca?raw)