Get 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>",
      "type": "GOOGLE",
      "url": "<string>",
      "weight": "200",
      "uppercase": true
    },
    "body": {
      "name": "<string>",
      "type": "GOOGLE",
      "url": "<string>",
      "weight": "200",
      "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

Color theme configuration for light and dark modes.

Show child attributes

colors.supports_dark_mode

boolean | null

Whether the app supports dark mode themes.

colors.light

object

Light mode color configuration.

Show child attributes

colors.light.background

string | null

Default background color.

colors.light.foreground

string | null

Default text color.

colors.light.primary

string | null

Button background color and inline link color.

colors.light.primary_foreground

string | null

Button text color.

colors.light.border

string | null

Default border color.

colors.light.border_card

string | null

Card border color.

colors.light.border_header

string | null

Navbar bottom border color.

colors.light.border_input

string | null

Input border color.

colors.light.destructive

string | null

Error messages, error toasts, and destructive button background color (red).

colors.light.destructive_foreground

string | null

Error messages, error toasts, and destructive button text color.

colors.light.success

string | null

Success toast background color.

colors.light.success_foreground

string | null

Success toast text color.

colors.light.muted

string | null

Muted background color.

colors.light.muted_foreground

string | null

Muted text color.

colors.light.accent

string | null

Accent background color.

colors.light.accent_foreground

string | null

Accent text color.

colors.light.fill_header

string | null

Navbar icon fill color.

Mobile menu icon fill color.

Mobile menu link color.

colors.light.bg_header

string | null

Navbar background color.

colors.light.bg_card

string | null

Card background color.

Mobile menu background color.

colors.light.bg_overlay

string | null

Modal / dialog overlay background color (slightly translucent).

colors.light.shadow_header

string | null

Navbar drop shadow.

colors.dark

object

Dark mode color configuration.

Show child attributes

colors.dark.background

string | null

Default background color.

colors.dark.foreground

string | null

Default text color.

colors.dark.primary

string | null

Button background color and inline link color.

colors.dark.primary_foreground

string | null

Button text color.

colors.dark.border

string | null

Default border color.

colors.dark.border_card

string | null

Card border color.

colors.dark.border_header

string | null

Navbar bottom border color.

colors.dark.border_input

string | null

Input border color.

colors.dark.destructive

string | null

Error messages, error toasts, and destructive button background color (red).

colors.dark.destructive_foreground

string | null

Error messages, error toasts, and destructive button text color.

colors.dark.success

string | null

Success toast background color.

colors.dark.success_foreground

string | null

Success toast text color.

colors.dark.muted

string | null

Muted background color.

colors.dark.muted_foreground

string | null

Muted text color.

colors.dark.accent

string | null

Accent background color.

colors.dark.accent_foreground

string | null

Accent text color.

colors.dark.fill_header

string | null

Navbar icon fill color.

Mobile menu icon fill color.

Mobile menu link color.

colors.dark.bg_header

string | null

Navbar background color.

colors.dark.bg_card

string | null

Card background color.

Mobile menu background color.

colors.dark.bg_overlay

string | null

Modal / dialog overlay background color (slightly translucent).

colors.dark.shadow_header

string | null

Navbar drop shadow.

typography

object

Typography configuration for the app.

Show child attributes

typography.heading

object

Font settings for headings.

Show child attributes

typography.heading.name

string

required

Name of the font.

typography.heading.type

enum<string>

required

Font type.

Available options:

GOOGLE,

ADOBE,

SYSTEM,

CUSTOM

typography.heading.url

string<uri> | null

URL to the custom or Google font.

typography.heading.weight

enum<string> | null

Font weight.

Available options:

200,

300,

400,

500,

600,

700

typography.heading.uppercase

boolean | null

Whether the font should be uppercase.

typography.body

object

Font settings for body text.

Show child attributes

typography.body.name

string

required

Name of the font.

typography.body.type

enum<string>

required

Font type.

Available options:

GOOGLE,

ADOBE,

SYSTEM,

CUSTOM

typography.body.url

string<uri> | null

URL to the custom or Google font.

typography.body.weight

enum<string> | null

Font weight.

Available options:

200,

300,

400,

500,

600,

700

typography.body.uppercase

boolean | null

Whether the font should be uppercase.

typography.button_uppercase

boolean | null

Whether button text should be uppercase.

typography.use_body_for_headings

boolean | null

Whether to use body font for headings.

Navigation menu configuration.

Show child attributes

Unique identifier for the menu item.

Local path or external URL to website.

Display name for the menu item.

Whether the link should open a new tab.

seo_settings

object

SEO configuration for the app.

Show child attributes

seo_settings.title

string | null

Default SEO title for site.

seo_settings.description

string | null

Default SEO description for site.

seo_settings.template

string | null

Default SEO template for site (e.g., "%s | Company Name").

seo_settings.image

string<uri> | null

Default SEO image for site.

layout_settings

object

Layout and styling configuration for the app.

Show child attributes

layout_settings.header_layout

enum<string> | null

Navbar style on desktop.

Available options:

DEFAULT,

CENTER,

CENTER_REVERSE

layout_settings.header_layout_mobile

enum<string> | null

Navbar style on mobile.

Available options:

DEFAULT,

CENTER,

CENTER_REVERSE

layout_settings.header_sticky

boolean | null

Whether the navbar is sticky on desktop.

layout_settings.header_sticky_mobile

boolean | null

Whether the navbar is sticky on mobile.

layout_settings.header_padding

string | null

Padding for primary nav bar element.

layout_settings.header_padding_mobile

string | null

Padding for primary nav bar element on mobile.

layout_settings.card_padding

string | null

Default padding for all card and card-type elements.

layout_settings.border_radius

string | null

Default border radius if card and button are not specified.

layout_settings.border_radius_card

string | null

Border radius for all card and card-type elements.

layout_settings.border_radius_button

string | null

Border radius for all button elements.

layout_settings.logo_height

string | null

Height of the logo image on desktop (includes unit).

layout_settings.logo_height_mobile

string | null

Height of the logo image on mobile (includes unit).

layout_settings.icon_account

enum<string> | null

Account icon preset.

Available options:

DEFAULT,

NONE

layout_settings.icon_hamburger

enum<string> | null

Hamburger icon preset.

Available options:

DEFAULT

Array of social media links and website URLs.

Show child attributes

URL to social media account.

Social platform type.

Available options:

X,

INSTAGRAM,

FACEBOOK,

TIKTOK,

YOUTUBE,

LINKEDIN,

TWITCH,

DISCORD,

WEBSITE

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.

Show child attributes

favicon.alt

string | null

Alternative text for the media.

favicon.created_at

string<date-time>

The creation timestamp of the media.

favicon.description

string | null

Description of the media.

favicon.file_type

string | null

The file type of the media.

favicon.id

integer

The unique identifier for the media.

favicon.poster_url

string<uri> | null

URL to the poster of the media.

favicon.size

integer | null

The size of the media in bytes.

favicon.tags

string[] | null

Tags associated with the media.

favicon.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

favicon.updated_at

string<date-time> | null

The last updated timestamp of the media.

favicon.url

string<uri>

URL to the media.

logo

object

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

Show child attributes

logo.alt

string | null

Alternative text for the media.

logo.created_at

string<date-time>

The creation timestamp of the media.

logo.description

string | null

Description of the media.

logo.file_type

string | null

The file type of the media.

logo.id

integer

The unique identifier for the media.

logo.poster_url

string<uri> | null

URL to the poster of the media.

logo.size

integer | null

The size of the media in bytes.

logo.tags

string[] | null

Tags associated with the media.

logo.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

logo.updated_at

string<date-time> | null

The last updated timestamp of the media.

logo.url

string<uri>

URL to the media.

logo_dark

object

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

Show child attributes

logo_dark.alt

string | null

Alternative text for the media.

logo_dark.created_at

string<date-time>

The creation timestamp of the media.

logo_dark.description

string | null

Description of the media.

logo_dark.file_type

string | null

The file type of the media.

logo_dark.id

integer

The unique identifier for the media.

logo_dark.poster_url

string<uri> | null

URL to the poster of the media.

logo_dark.size

integer | null

The size of the media in bytes.

logo_dark.tags

string[] | null

Tags associated with the media.

logo_dark.thumbnail_url

string<uri> | null

URL to the thumbnail of the media.

logo_dark.updated_at

string<date-time> | null

The last updated timestamp of the media.

logo_dark.url

string<uri>

URL to the media.

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

Show child attributes

Alternative text for the media.

The creation timestamp of the media.

Description of the media.

The file type of the media.

The unique identifier for the media.

URL to the poster of the media.

The size of the media in bytes.

Tags associated with the media.

URL to the thumbnail of the media.

The last updated timestamp of the media.

URL to the media.

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.

Get inventoryFetches the inventory information for the team associated with the API key. This includes chip model details, quantities in various states (available, encoded, owned, reserved, damaged), and other inventory tracking information.

⌘I

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>",
      "type": "GOOGLE",
      "url": "<string>",
      "weight": "200",
      "uppercase": true
    },
    "body": {
      "name": "<string>",
      "type": "GOOGLE",
      "url": "<string>",
      "weight": "200",
      "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"
}

Getting Started

Access API

Activities API

Analytics API

Collections API

Registrations API

Short URLs API

Teams API

Users API

Authorizations

Response