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

Responses

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

Responses

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

Responses

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

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

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

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

Responses

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

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

Responses