---
title: "Return the MarkupMacroComponents for that client - with cache."
method: GET
path: "/Ams/{ClientID}/MarkupMacroComponents"
tags: ["Ams"]
---

# Return the MarkupMacroComponents for that client - with cache.

`GET /Ams/{ClientID}/MarkupMacroComponents`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/MarkupMacroComponents`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/MarkupMacroComponents/get.ts> (a function with typed inputs; its response is checked against the schema)

Return the MarkupMacroComponents for that client - with cache.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `MarkupType` string
- `ComponentId` integer
- `ComponentData` string
- `MacroComponentName` string
- `MacroComponentId` integer
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- MarkupMacroComponentsResponse: MarkupMacroComponentsResponse
  - `Components` MacroComponent[]
    - `MacroComponentId` integer
    - `IsShared` boolean
    - `Name` string
    - `ComponentData` MarkupComponentData: MarkupComponentData
      - `ComponentType` string
      - `ComponentName` string
      - `IsAtRootColumn` boolean
      - `CanHaveChildren` boolean
      - `OrderId` integer
      - `ButtonData` ButtonData: ButtonData
        - `Properties` ButtonProperties: ButtonProperties
          - `Text` string
          - `Link` string
        - `Settings` ButtonSettings: ButtonSettings
          - `ButtonColor` string
          - `TextColor` string
          - `Alignment` string
          - `ButtonWidth` string
          - `MarginTop` integer
          - `MarginBottom` integer
          - `MarginLeft` integer
          - `MarginRight` integer
      - `ImageData` ImageData: ImageData
        - `Properties` ImageProperties: ImageProperties
          - `URL` string
          - `HyperLink` string
          - `AltText` string
        - `Settings` ImageSettings: ImageSettings
          - `Alignment` string
          - `MarginTop` integer
          - `MarginBottom` integer
          - `MarginLeft` integer
          - `MarginRight` integer
          - `Width` integer
          - `Height` integer
      - `DividerData` DividerData: DividerData
        - `Settings` DividerSettings: DividerSettings
          - `MarginTop` integer
          - `MarginBottom` integer
          - `MarginLeft` integer
          - `MarginRight` integer
          - `BorderColor` string
          - `Height` integer
      - `TextData` TextData: TextData
        - `Properties` TextProperties: TextProperties
          - `Text` string
        - `Settings` TextSettings: TextSettings
          - `MarginTop` integer
          - `MarginBottom` integer
          - `MarginLeft` integer
          - `MarginRight` integer
      - `ContainerData` ContainerData: ContainerData
        - `Properties` ContainerProperties: ContainerProperties
        - `Settings` ContainerSettings: ContainerSettings
          - `BackgroundColor` string
          - `MarginTop` integer
          - `MarginBottom` integer
          - `MarginLeft` integer
          - `MarginRight` integer
        - `Columns` ListMarkupComponentData[]
          - MarkupComponentData[]
      - `PlainText` string
  - `ContainerId` integer
  - `MarkupType` string
  - `ComponentId` integer
  - `ComponentData` MarkupComponentData: MarkupComponentData
    - `ComponentType` string
    - `ComponentName` string
    - `IsAtRootColumn` boolean
    - `CanHaveChildren` boolean
    - `OrderId` integer
    - `ButtonData` ButtonData: ButtonData
      - `Properties` ButtonProperties: ButtonProperties
        - `Text` string
        - `Link` string
      - `Settings` ButtonSettings: ButtonSettings
        - `ButtonColor` string
        - `TextColor` string
        - `Alignment` string
        - `ButtonWidth` string
        - `MarginTop` integer
        - `MarginBottom` integer
        - `MarginLeft` integer
        - `MarginRight` integer
    - `ImageData` ImageData: ImageData
      - `Properties` ImageProperties: ImageProperties
        - `URL` string
        - `HyperLink` string
        - `AltText` string
      - `Settings` ImageSettings: ImageSettings
        - `Alignment` string
        - `MarginTop` integer
        - `MarginBottom` integer
        - `MarginLeft` integer
        - `MarginRight` integer
        - `Width` integer
        - `Height` integer
    - `DividerData` DividerData: DividerData
      - `Settings` DividerSettings: DividerSettings
        - `MarginTop` integer
        - `MarginBottom` integer
        - `MarginLeft` integer
        - `MarginRight` integer
        - `BorderColor` string
        - `Height` integer
    - `TextData` TextData: TextData
      - `Properties` TextProperties: TextProperties
        - `Text` string
      - `Settings` TextSettings: TextSettings
        - `MarginTop` integer
        - `MarginBottom` integer
        - `MarginLeft` integer
        - `MarginRight` integer
    - `ContainerData` ContainerData: ContainerData
      - `Properties` ContainerProperties: ContainerProperties
      - `Settings` ContainerSettings: ContainerSettings
        - `BackgroundColor` string
        - `MarginTop` integer
        - `MarginBottom` integer
        - `MarginLeft` integer
        - `MarginRight` integer
      - `Columns` ListMarkupComponentData[]
        - MarkupComponentData[]
    - `PlainText` string
  - `MacroComponentName` string
  - `MacroComponentId` integer
  - `UsingRedis` boolean
  - `AppInitTime` string, date-time
  - `ServerID` string
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)