Preview a suspension

GET

/api/v1/admin/teams/{id}/suspension-preview

curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/admin/teams/example/suspension-preview \
  --header 'Authorization: <Authorization>'

For the team about to be suspended: its owners and admins (with owner_by_transfer_at when they became owner of this team by an accepted ownership transfer in the last 90 days) and, per person, the other teams they own with the plan, the owner count and what a cascade class would do to each (suspended, held with a hold_reason, or already_suspended). Read-only.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Team ID (UUID)

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

candidates

Array<object>

object

can_confirm_transferee

CanConfirmTransferee: the admin may name them in confirmed_transferee_ids, which makes their teams classify like any subject’s (OutcomeIfConfirmed). False when the transfer lookup failed: an unknown is never confirmable.

boolean

email

string

is_transferee

IsTransferee: their teams are all held (T1) unless the admin confirms them. True when OwnerByTransferAt is set or the lookup failed.

boolean

owned_teams

Array<object>

object

hold_reason

string

hold_reason_if_confirmed

string

outcome

Outcome is the row state the cascade would write: pending (suspend), held or already_suspended.

string

outcome_if_confirmed

OutcomeIfConfirmed / HoldReasonIfConfirmed: what the cascade does to this team when the candidate is a confirmable transferee and the admin confirms them. Absent otherwise.

string

owner_count

integer

plan

string

team_id

string

team_name

string

owner_by_transfer_at

OwnerByTransferAt is when they accepted an ownership offer of the origin, if within the last 90 days (T1: such a person is not pre-ticked and never auto-cascades).

string

role

string

transfer_lookup_failed

TransferLookupFailed: the transfer could not be read, so they are treated as a transferee.

boolean

user_id

string

origin_team_id

string

origin_team_name

string

Example ^generated

{
  "data": {
    "candidates": [
      {
        "can_confirm_transferee": true,
        "email": "example",
        "is_transferee": true,
        "owned_teams": [
          {
            "hold_reason": "example",
            "hold_reason_if_confirmed": "example",
            "outcome": "example",
            "outcome_if_confirmed": "example",
            "owner_count": 1,
            "plan": "example",
            "team_id": "example",
            "team_name": "example"
          }
        ],
        "owner_by_transfer_at": "example",
        "role": "example",
        "transfer_lookup_failed": true,
        "user_id": "example"
      }
    ],
    "origin_team_id": "example",
    "origin_team_name": "example"
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

400

Bad Request

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Not Found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

Internal Server Error

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Service Unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}