---
title: "List Account Settings"
method: GET
path: "/2024-09/account/settings"
tags: ["Settings"]
---

# List Account Settings

`GET /2024-09/account/settings`

## Request

- Base URL: `https://public-api.easyship.com`
- URL: `https://public-api.easyship.com/2024-09/account/settings`
- Auth: HTTP bearer

Retrieve account settings.

Required authorization scope: `public.setting:read`

## Response `200`

settings successfully updated

- SettingSingle: Setting
  - `setting` Setting
    - `tracking_email` object
      - `display_options` object
        - `header` boolean: Show the company logo in the tracking email. If this parameter is set to `true` but no logo is uploaded, the header will display the company name.
        - `contact` boolean: Show the contact page with social media
      - `allowed_statuses` string[], nullable: Select a shipment status to trigger a tracking updates email
      - `button` object
        - `background_color` string: Background color in HEX color code format
        - `text_color` string: Text color in HEX color code format
      - `footnote` string
      - `advertising` object, nullable
        - `title` 'Call Now' | 'Book Now' | 'Buy Now' | 'Contact Us' | 'Learn More' | 'See Offer' | 'Sign Up' | 'Shop Now' | 'Use App' | 'Visit Us' | 'Leave a Review' | 'Leave a Comment', required: Advertising button in the tracking email
        - `url` string, uri, required: Link for the advertising button
    - `tracking_page` object
      - `display_options` object
        - `header` boolean: Show the company logo in the tracking page. If this parameter is set to `true` but no logo is uploaded, the header will display the company name.
        - `estimated_delivery_time` boolean: Show estimated delivery time
        - `status_icon` boolean: Show an animated icon with delivery status
        - `contact_courier` boolean: Show the link of courier's contact page
        - `contact` boolean: Show the contact page with social media
      - `button` object
        - `background_color` string: Background color in HEX color code format
        - `text_color` string: Text color in HEX color code format
      - `footnote` string
      - `advertising` object, nullable
        - `title` 'Call Now' | 'Book Now' | 'Buy Now' | 'Contact Us' | 'Learn More' | 'See Offer' | 'Sign Up' | 'Shop Now' | 'Use App' | 'Visit Us' | 'Leave a Review' | 'Leave a Comment', required: Advertising button in the tracking page
        - `url` string, uri, required: Link for the advertising button
  - `meta` Meta
    - `request_id` string: An unique ID represent the request.

---

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