Team v1.0.0

Get your teams

GET https://my.sitebay.org/f/api/v1/team

Get details about all of your owned and member teams. SiteBot enabled.

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

page

Type:: integer >= 1
Default: 1
Default:: 1

Page number

size

Type:: integer 1..100
Default: 50
Default:: 50

Page size

Response Samples

{
  "count": null,
  "limit": null,
  "next": null,
  "offset": null,
  "previous": null,
  "results": [
    {
      "additional_sites": null,
      "cancel_at": null,
      "cancel_at_period_end": null,
      "created_at": null,
      "currency": null,
      "current_cycle_bandwidth": null,
      "current_cycle_visits": null,
      "cycle_end": null,
      "cycle_start": null,
      "grafana_org_id": null,
      "id": null,
      "interval": null,
      "is_active": null,
      "is_default": null,
      "is_expired": null,
      "name": null,
      "plan_type": null,
      "plan_type_name": null,
      "posthog_team_id": null,
      "should_allow_shopify_payment": null,
      "storage_usage": null,
      "storage_usage_percentage": null,
      "sub_id": null,
      "tenant_id": null,
      "timezone": null,
      "trial_ends_on": null,
      "user": {
        "created_at": null,
        "email": null,
        "first_name": null,
        "full_name": null,
        "id": null,
        "is_active": null,
        "is_payment_verified": null,
        "is_superuser": null,
        "is_verified": null,
        "last_name": null,
        "posthog_user_id": null
      },
      "user_id": null,
      "visits_usage_percentage": null
    }
  ]
}

Responses

Successful Response

count

Required

integer

limit

Required

integer >= 1

Required

offset

Required

integer >= 0

Required

results

Required

array
of objects

additional_sites

cancel_at

cancel_at_period_end

boolean

created_at

string<date-time>

currency

current_cycle_bandwidth

integer

current_cycle_visits

integer

cycle_end

cycle_start

grafana_org_id

string<uuid4>

interval

is_active

boolean

is_default

boolean

is_expired

boolean

name

string

plan_type

object

plan_type_name

string

posthog_team_id

should_allow_shopify_payment

boolean

storage_usage

integer

storage_usage_percentage

integer

sub_id

tenant_id

string

timezone

string

trial_ends_on

user

object

created_at Required	`string<date-time>`
email Required	`string<email>`
first_name Required
full_name Required	`string`
id Required	`string<uuid4>`
is_active	`boolean` Default: `true`
is_payment_verified Required	`boolean`
is_superuser	`boolean` Default: `false`
is_verified	`boolean` Default: `false`
last_name Required
posthog_user_id Required

user_id

string<uuid4>

visits_usage_percentage

integer

Get a team

GET https://my.sitebay.org/f/api/v1/team/{team_id}

Get details about an owned or member team by its ID

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

Response Samples

{
  "additional_sites": null,
  "cancel_at": null,
  "cancel_at_period_end": null,
  "created_at": null,
  "currency": null,
  "current_cycle_bandwidth": null,
  "current_cycle_visits": null,
  "cycle_end": null,
  "cycle_start": null,
  "grafana_org_id": null,
  "id": null,
  "interval": null,
  "is_active": null,
  "is_default": null,
  "is_expired": null,
  "name": null,
  "plan_type": null,
  "plan_type_name": null,
  "posthog_team_id": null,
  "should_allow_shopify_payment": null,
  "storage_usage": null,
  "storage_usage_percentage": null,
  "sub_id": null,
  "tenant_id": null,
  "timezone": null,
  "trial_ends_on": null,
  "user": {
    "created_at": null,
    "email": null,
    "first_name": null,
    "full_name": null,
    "id": null,
    "is_active": null,
    "is_payment_verified": null,
    "is_superuser": null,
    "is_verified": null,
    "last_name": null,
    "posthog_user_id": null
  },
  "user_id": null,
  "visits_usage_percentage": null
}

Responses

Successful Response

additional_sites

cancel_at

cancel_at_period_end

Required

boolean

created_at

Required

string<date-time>

currency

current_cycle_bandwidth

Required

integer

current_cycle_visits

Required

integer

cycle_end

cycle_start

grafana_org_id

Required

string<uuid4>

interval

is_active

Required

boolean

is_default

Required

boolean

is_expired

Required

boolean

name

Required

string

plan_type

Required

object

plan_type_name

Required

string

posthog_team_id

should_allow_shopify_payment

Required

boolean

storage_usage

Required

integer

storage_usage_percentage

Required

integer

sub_id

tenant_id

Required

string

timezone

Required

string

trial_ends_on

user

Required

object

created_at Required	`string<date-time>`
email Required	`string<email>`
first_name Required
full_name Required	`string`
id Required	`string<uuid4>`
is_active	`boolean` Default: `true`
is_payment_verified Required	`boolean`
is_superuser	`boolean` Default: `false`
is_verified	`boolean` Default: `false`
last_name Required
posthog_user_id Required

user_id

Required

string<uuid4>

visits_usage_percentage

Required

integer

Update a Team

PATCH https://my.sitebay.org/f/api/v1/team/{team_id}

Adjust your team’s settings

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

Request Body Schema

name
timezone

Response Samples

{
  "additional_sites": null,
  "cancel_at": null,
  "cancel_at_period_end": null,
  "created_at": null,
  "currency": null,
  "current_cycle_bandwidth": null,
  "current_cycle_visits": null,
  "cycle_end": null,
  "cycle_start": null,
  "grafana_org_id": null,
  "id": null,
  "interval": null,
  "is_active": null,
  "is_default": null,
  "is_expired": null,
  "name": null,
  "plan_type": null,
  "plan_type_name": null,
  "posthog_team_id": null,
  "should_allow_shopify_payment": null,
  "storage_usage": null,
  "storage_usage_percentage": null,
  "sub_id": null,
  "tenant_id": null,
  "timezone": null,
  "trial_ends_on": null,
  "user": {
    "created_at": null,
    "email": null,
    "first_name": null,
    "full_name": null,
    "id": null,
    "is_active": null,
    "is_payment_verified": null,
    "is_superuser": null,
    "is_verified": null,
    "last_name": null,
    "posthog_user_id": null
  },
  "user_id": null,
  "visits_usage_percentage": null
}

Responses

Successful Response

additional_sites

cancel_at

cancel_at_period_end

Required

boolean

created_at

Required

string<date-time>

currency

current_cycle_bandwidth

Required

integer

current_cycle_visits

Required

integer

cycle_end

cycle_start

grafana_org_id

Required

string<uuid4>

interval

is_active

Required

boolean

is_default

Required

boolean

is_expired

Required

boolean

name

Required

string

plan_type

Required

object

plan_type_name

Required

string

posthog_team_id

should_allow_shopify_payment

Required

boolean

storage_usage

Required

integer

storage_usage_percentage

Required

integer

sub_id

tenant_id

Required

string

timezone

Required

string

trial_ends_on

user

Required

object

created_at Required	`string<date-time>`
email Required	`string<email>`
first_name Required
full_name Required	`string`
id Required	`string<uuid4>`
is_active	`boolean` Default: `true`
is_payment_verified Required	`boolean`
is_superuser	`boolean` Default: `false`
is_verified	`boolean` Default: `false`
last_name Required
posthog_user_id Required

user_id

Required

string<uuid4>

visits_usage_percentage

Required

integer

Get Team Events

GET https://my.sitebay.org/f/api/v1/team/{team_id}/event

Get events, such as restores, updates, stage creations, etc.

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id	Type: `string<uuid4>` Default:
after_datetime	Type: Default:
page	Type: `integer` >= 1 Default: `1` Default: 1 Page number
size	Type: `integer` 1..100 Default: `50` Default: 50 Page size

Response Samples

{
  "count": null,
  "limit": null,
  "next": null,
  "offset": null,
  "previous": null,
  "results": [
    {
      "activity": null,
      "created_at": null,
      "description": null,
      "detail": null,
      "event_type": null,
      "finished_at": null,
      "fqdn": null,
      "id": null,
      "item_id": null,
      "scope": null,
      "site_live_id": null,
      "unread": null,
      "user": null,
      "user_id": null
    }
  ]
}

Responses

Get a team's invites

GET https://my.sitebay.org/f/api/v1/team/{team_id}/invite

Get a list of Team Members

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

page

Type:: integer >= 1
Default: 1
Default:: 1

Page number

size

Type:: integer 1..100
Default: 50
Default:: 50

Page size

Response Samples

{
  "count": null,
  "limit": null,
  "next": null,
  "offset": null,
  "previous": null,
  "results": [
    {
      "created_at": null,
      "created_by": null,
      "expiry": null,
      "first_name": null,
      "id": null,
      "link": null,
      "role": null,
      "target_email": null
    }
  ]
}

Responses

Create Team Member Invite

POST https://my.sitebay.org/f/api/v1/team/{team_id}/invite

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

Request Body Schema

first_name	`string`
message
target_email	`string`

Response Samples

{
  "created_at": null,
  "created_by": null,
  "expiry": null,
  "first_name": null,
  "id": null,
  "link": null,
  "role": null,
  "target_email": null
}

Responses

Delete Team Member Invite

DELETE https://my.sitebay.org/f/api/v1/team/{team_id}/invite/{team_member_invite_id}

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id	Type: `string<uuid4>` Default:
team_member_invite_id	Type: `string<uuid4>` Default:

Response Samples

Responses

Get a team's members

GET https://my.sitebay.org/f/api/v1/team/{team_id}/member

Get a list of Team Members

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

page

Type:: integer >= 1
Default: 1
Default:: 1

Page number

size

Type:: integer 1..100
Default: 50
Default:: 50

Page size

Response Samples

{
  "count": null,
  "limit": null,
  "next": null,
  "offset": null,
  "previous": null,
  "results": [
    {
      "id": null,
      "joined_at": null,
      "level": null,
      "role": null,
      "team_id": null,
      "user": {
        "created_at": null,
        "email": null,
        "first_name": null,
        "full_name": null,
        "id": null,
        "is_active": null,
        "is_payment_verified": null,
        "is_superuser": null,
        "is_verified": null,
        "last_name": null,
        "posthog_user_id": null
      },
      "user_id": null
    }
  ]
}

Responses

Your teams members

count

Required

integer

limit

Required

integer >= 1

Required

offset

Required

integer >= 0

Required

results

Required

array
of objects

string<uuid4>

joined_at

string<date-time>

level

integer

role

string

team_id

string<uuid4>

user

object

created_at Required	`string<date-time>`
email Required	`string<email>`
first_name Required
full_name Required	`string`
id Required	`string<uuid4>`
is_active	`boolean` Default: `true`
is_payment_verified Required	`boolean`
is_superuser	`boolean` Default: `false`
is_verified	`boolean` Default: `false`
last_name Required
posthog_user_id Required

user_id

string<uuid4>

Get Team Member

GET https://my.sitebay.org/f/api/v1/team/{team_id}/member/{team_member_id}

Get a Team Member by their UUID

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_member_id	Type: `string<uuid4>` Default:
team_id	Type: `string<uuid4>` Default:

Response Samples

{
  "id": null,
  "joined_at": null,
  "level": null,
  "role": null,
  "team_id": null,
  "user": {
    "created_at": null,
    "email": null,
    "first_name": null,
    "full_name": null,
    "id": null,
    "is_active": null,
    "is_payment_verified": null,
    "is_superuser": null,
    "is_verified": null,
    "last_name": null,
    "posthog_user_id": null
  },
  "user_id": null
}

Responses

Remove Team Member

DELETE https://my.sitebay.org/f/api/v1/team/{team_id}/member/{team_member_user_id}

Remove a team member

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_member_user_id	Type: `string<uuid4>` Default:
team_id	Type: `string<uuid4>` Default:

Response Samples

Responses

Get a team's tickets

GET https://my.sitebay.org/f/api/v1/team/{team_id}/ticket

Get a list of Team Tickets

Authorizations

OAuth2PasswordBearer
APIKeyCookie

Query Parameters

team_id

Type:: string<uuid4>
Default:

page

Type:: integer >= 1
Default: 1
Default:: 1

Page number

size

Type:: integer 1..100
Default: 50
Default:: 50

Page size

Response Samples

{
  "count": null,
  "limit": null,
  "next": null,
  "offset": null,
  "previous": null,
  "results": [
    {
      "category": null,
      "created_at": null,
      "description": null,
      "id": null,
      "is_openai_thread": null,
      "messages_remaining": null,
      "openai_custom_instructions": null,
      "resolved": null,
      "resolved_at": null,
      "subject": null,
      "team_id": null,
      "ticket_replies": [
        {
          "created_at": null,
          "description": null,
          "id": null,
          "is_gpt_chat_message": null,
          "openai_message_id": null,
          "resolve": null,
          "user": {
            "created_at": null,
            "email": null,
            "first_name": null,
            "full_name": null,
            "id": null,
            "is_active": null,
            "is_payment_verified": null,
            "is_superuser": null,
            "is_verified": null,
            "last_name": null,
            "posthog_user_id": null
          }
        }
      ]
    }
  ]
}

Responses

Your teams tickets

count

Required

integer

limit

Required

integer >= 1

Required

offset

Required

integer >= 0

Required

results

Required

array
of objects

Search Results

No Results

Filters

Team v1.0.0

Get your teams

Authorizations

Query Parameters

Response Samples

Responses

Get a team

Authorizations

Query Parameters

Response Samples

Responses

Update a Team

Authorizations

Query Parameters

Request Body Schema

Response Samples

Responses

Get Team Events

Authorizations

Query Parameters

Response Samples

Responses

Get a team's invites

Authorizations

Query Parameters

Response Samples

Responses

Create Team Member Invite

Authorizations

Query Parameters

Request Body Schema

Response Samples

Responses

Delete Team Member Invite

Authorizations

Query Parameters

Response Samples

Responses

Get a team's members

Authorizations

Query Parameters

Response Samples

Responses

Get Team Member

Authorizations

Query Parameters

Response Samples

Responses

Remove Team Member

Authorizations

Query Parameters

Response Samples

Responses

Get a team's tickets

Authorizations

Query Parameters

Response Samples

Responses

On this page