GET
/
v1
/
team
Get team
curl --request GET \
  --url https://api.oneofnone.io/v1/team \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "website": "<string>",
  "description": "<string>",
  "seat_count": 123,
  "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>"
  },
  "notification_settings": {
    "weekly_digest": true,
    "project_reminders": true,
    "chip_status_updates": true,
    "collab_requests": true,
    "team_member_activity": true
  },
  "social_links": [
    {
      "url": "<string>",
      "type": "X"
    }
  ],
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "shipping_address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "city": "<string>",
    "principal_subdivision": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "billing_address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "city": "<string>",
    "principal_subdivision": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "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 information.

A team or organization within the platform, containing profile information, settings, and associated addresses.

​
id
string<uuid>

The unique identifier for the team.

​
name
string

The name of the team or organization.

​
slug
string | null

The URL-friendly slug for the team.

​
website
string<uri> | null

The team's website URL.

​
description
string | null

A description of the team or organization.

​
seat_count
integer | null

The number of seats or members allowed for this team.

The team's logo image. Note that only the url field is populated in team responses.

​
logo_dark
object

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

​
notification_settings
object | null

Team-wide notification preferences and settings.

​
social_links
object[] | null

Array of social media links and website URLs for the team.

​
created_by
object | null

Information about the user who created this team.

​
shipping_address
object

A standardized address structure for billing, shipping, and other location-based data. The default shipping address for the team.

​
billing_address
object

A standardized address structure for billing, shipping, and other location-based data. The billing address for the team.

​
created_at
string<date-time>

The timestamp when the team was created.

​
updated_at
string<date-time> | null

The timestamp when the team was last updated.