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 |
Page number |
size |
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
}
]
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Successful Response
count Required | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit Required | integer
>=
1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next Required |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset Required | integer
>=
0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous Required |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results Required | array
of objects
|
Validation Error
detail | array
of objects
|
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 |
|
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
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": 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 |
| ||||||||||||||||||||||
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
| ||||||||||||||||||||||
user_id Required | string<uuid4> | ||||||||||||||||||||||
visits_usage_percentage Required | integer |
Validation Error
detail | array
of objects
|
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 |
|
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
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": 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 |
| ||||||||||||||||||||||
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
| ||||||||||||||||||||||
user_id Required | string<uuid4> | ||||||||||||||||||||||
visits_usage_percentage Required | integer |
Validation Error
detail | array
of objects
|
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 |
|
after_datetime |
|
page |
Page number |
size |
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
}
]
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
JSON
count Required | integer | ||||||||||||||||||||||||||||
limit Required | integer
>=
1 | ||||||||||||||||||||||||||||
next Required |
| ||||||||||||||||||||||||||||
offset Required | integer
>=
0 | ||||||||||||||||||||||||||||
previous Required |
| ||||||||||||||||||||||||||||
results Required | array
of objects
|
Validation Error
detail | array
of objects
|
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 |
|
page |
Page number |
size |
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
}
]
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Your teams members
count Required | integer | ||||||||||||||||
limit Required | integer
>=
1 | ||||||||||||||||
next Required |
| ||||||||||||||||
offset Required | integer
>=
0 | ||||||||||||||||
previous Required |
| ||||||||||||||||
results Required | array
of objects
|
Validation Error
detail | array
of objects
|
Create Team Member Invite
POST
https://my.sitebay.org/f/api/v1/team/{team_id}/invite
Authorizations
OAuth2PasswordBearer | |
APIKeyCookie |
Query Parameters
team_id |
|
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
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Successful Response
created_at | string<date-time> |
created_by |
|
expiry | string<date-time> |
first_name |
|
id | string<uuid4> |
link | string |
role | string |
target_email | string |
Validation Error
detail | array
of objects
|
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 |
|
team_member_invite_id |
|
Response Samples
{}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Successful Response
Validation Error
detail | array
of objects
|
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 |
|
page |
Page number |
size |
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
}
]
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Your teams members
count Required | integer | ||||||||||||||||||||||||||||||||||||
limit Required | integer
>=
1 | ||||||||||||||||||||||||||||||||||||
next Required |
| ||||||||||||||||||||||||||||||||||||
offset Required | integer
>=
0 | ||||||||||||||||||||||||||||||||||||
previous Required |
| ||||||||||||||||||||||||||||||||||||
results Required | array
of objects
|
Validation Error
detail | array
of objects
|
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 |
|
team_id |
|
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
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Successful Response
id Required | string<uuid4> | ||||||||||||||||||||||
joined_at Required | string<date-time> | ||||||||||||||||||||||
level Required | integer | ||||||||||||||||||||||
role Required | string | ||||||||||||||||||||||
team_id Required | string<uuid4> | ||||||||||||||||||||||
user Required | object
| ||||||||||||||||||||||
user_id Required | string<uuid4> |
Validation Error
detail | array
of objects
|
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 |
|
team_id |
|
Response Samples
{}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Successful Response
Validation Error
detail | array
of objects
|
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 |
|
page |
Page number |
size |
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
}
}
]
}
]
}
{
"detail": [
{
"loc": [
null
],
"msg": null,
"type": null
}
]
}
Responses
Your teams tickets
count Required | integer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit Required | integer
>=
1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next Required |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offset Required | integer
>=
0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previous Required |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
results Required | array
of objects
|
Validation Error
detail | array
of objects
|