GET
/
api
/
v1
/
team
/
{id}
curl --request GET \
  --url https://api.bundle.social/api/v1/team/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "avatarUrl": "<string>",
  "organizationId": "<string>",
  "createdById": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "organization": {
    "id": "<string>",
    "createdById": "<string>",
    "promotionCodeId": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "apiAccess": true,
    "ref": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "createdBy": {
    "id": "<string>",
    "externalId": "<string>",
    "email": "<string>",
    "emailVerified": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatarUrl": "<string>",
    "role": "ADMIN",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "bots": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "teamId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "socialAccounts": [
    {
      "id": "<string>",
      "type": "TIKTOK",
      "teamId": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "externalId": "<string>",
      "userUsername": "<string>",
      "userDisplayName": "<string>",
      "userId": "<string>",
      "channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "username": "<string>",
          "webhook": {
            "id": "<string>",
            "name": "<string>",
            "avatar": "<string>",
            "url": "<string>"
          }
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "bio": {
    "id": "<string>",
    "username": "<string>",
    "name": "<string>",
    "description": "<string>",
    "avatarUrl": "<string>",
    "socials": {},
    "teamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "items": [
      {
        "id": "<string>",
        "bioId": "<string>",
        "name": "<string>",
        "link": "<string>",
        "icon": "<string>",
        "enabled": true,
        "order": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "analytics": [
          {
            "id": "<string>",
            "count": 123,
            "bioItemId": "<string>",
            "deviceType": {},
            "country": {},
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Response

200
application/json
200
​
id
string
required
​
name
string
required
​
organizationId
string
required
​
createdById
string
required
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
organization
object
required
​
createdBy
object
required
​
bots
object[]
required
​
socialAccounts
object[]
required
​
avatarUrl
string | null
​
deletedAt
string | null
​
bio
object | null

Was this page helpful?

Suggest editsRaise issue