GET
/
v1
/
team
/
app-settings
Get team app settings
curl --request GET \
  --url https://api.oneofnone.io/v1/team/app-settings \
  --header 'x-api-key: <api-key>'
{
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "domain": "<string>",
  "status": "ACTIVE",
  "colors": {
    "supports_dark_mode": true,
    "light": {
      "background": "<string>",
      "foreground": "<string>",
      "primary": "<string>",
      "primary_foreground": "<string>",
      "border": "<string>",
      "border_card": "<string>",
      "border_header": "<string>",
      "border_input": "<string>",
      "destructive": "<string>",
      "destructive_foreground": "<string>",
      "success": "<string>",
      "success_foreground": "<string>",
      "muted": "<string>",
      "muted_foreground": "<string>",
      "accent": "<string>",
      "accent_foreground": "<string>",
      "fill_header": "<string>",
      "fill_nav_menu": "<string>",
      "link_nav_menu": "<string>",
      "bg_header": "<string>",
      "bg_card": "<string>",
      "bg_nav_menu": "<string>",
      "bg_overlay": "<string>",
      "shadow_header": "<string>"
    },
    "dark": {
      "background": "<string>",
      "foreground": "<string>",
      "primary": "<string>",
      "primary_foreground": "<string>",
      "border": "<string>",
      "border_card": "<string>",
      "border_header": "<string>",
      "border_input": "<string>",
      "destructive": "<string>",
      "destructive_foreground": "<string>",
      "success": "<string>",
      "success_foreground": "<string>",
      "muted": "<string>",
      "muted_foreground": "<string>",
      "accent": "<string>",
      "accent_foreground": "<string>",
      "fill_header": "<string>",
      "fill_nav_menu": "<string>",
      "link_nav_menu": "<string>",
      "bg_header": "<string>",
      "bg_card": "<string>",
      "bg_nav_menu": "<string>",
      "bg_overlay": "<string>",
      "shadow_header": "<string>"
    }
  },
  "typography": {
    "heading": {
      "name": "<string>",
      "url": "<string>",
      "weight": "200",
      "type": "GOOGLE",
      "uppercase": true
    },
    "body": {
      "name": "<string>",
      "url": "<string>",
      "weight": "200",
      "type": "GOOGLE",
      "uppercase": true
    },
    "button_uppercase": true,
    "use_body_for_headings": true
  },
  "menu": [
    {
      "id": 123,
      "path": "<string>",
      "label": "<string>",
      "new_tab": true
    }
  ],
  "seo_settings": {
    "title": "<string>",
    "description": "<string>",
    "template": "<string>",
    "image": "<string>"
  },
  "layout_settings": {
    "header_layout": "DEFAULT",
    "header_layout_mobile": "DEFAULT",
    "header_sticky": true,
    "header_sticky_mobile": true,
    "header_padding": "<string>",
    "header_padding_mobile": "<string>",
    "card_padding": "<string>",
    "border_radius": "<string>",
    "border_radius_card": "<string>",
    "border_radius_button": "<string>",
    "logo_height": "<string>",
    "logo_height_mobile": "<string>",
    "icon_account": "DEFAULT",
    "icon_hamburger": "DEFAULT"
  },
  "social_links": [
    {
      "url": "<string>",
      "type": "X"
    }
  ],
  "custom_css": "<string>",
  "favicon": {
    "alt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_type": "<string>",
    "id": 123,
    "poster_url": "<string>",
    "size": 123,
    "tags": [
      "<string>"
    ],
    "thumbnail_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>"
  },
  "logo": {
    "alt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_type": "<string>",
    "id": 123,
    "poster_url": "<string>",
    "size": 123,
    "tags": [
      "<string>"
    ],
    "thumbnail_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>"
  },
  "logo_dark": {
    "alt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_type": "<string>",
    "id": 123,
    "poster_url": "<string>",
    "size": 123,
    "tags": [
      "<string>"
    ],
    "thumbnail_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>"
  },
  "share_image": {
    "alt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_type": "<string>",
    "id": 123,
    "poster_url": "<string>",
    "size": 123,
    "tags": [
      "<string>"
    ],
    "thumbnail_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Response

Successfully retrieved team app settings.

Comprehensive configuration settings for a team's app including branding, layout, typography, colors, and functionality.

​
team_id
string<uuid> | null

The unique identifier of the team that owns this app.

​
name
string | null

The name of the team app.

​
domain
string | null

The custom domain for the team app.

​
status
enum<string> | null

The current status of the team app.

Available options:
ACTIVE,
INACTIVE
​
colors
object | null

Color theme configuration for light and dark modes.

​
typography
object | null

Typography configuration for the app.

​
menu
object[] | null

Navigation menu configuration.

​
seo_settings
object | null

SEO configuration for the app.

​
layout_settings
object | null

Layout and styling configuration for the app.

​
social_links
object[] | null

Array of social media links and website URLs.

​
custom_css
string | null

Custom CSS code for additional styling.

​
favicon
object

The favicon image for the app. Note that only the url field is populated in app responses.

The app logo image. Note that only the url field is populated in app responses.

​
logo_dark
object

The app dark mode logo image. Note that only the url field is populated in app responses.

​
share_image
object

The default social sharing image for the app. Note that only the url field is populated in app responses.

​
created_at
string<date-time>

The timestamp when the app configuration was created.

​
updated_at
string<date-time> | null

The timestamp when the app configuration was last updated.