Team

An organization team. Teams group org members for shared configuration. Each org has exactly one system team named "General" which is created automatically and cannot be deleted. Every team carries four role-contact slots embedded as full contact resources: registrant_contact and admin_contact are required on live teams; tech_contact and billing_contact are optional and may be null. The member_preview field is a capped, embedded snapshot of the team's most-recently-active members so frontends can render avatar stacks without a second round-trip. Use /teams/{team_id}/members for the full paginated list.

  • object
    Type: string

    Resource type identifier, always "team"

  • id
    Type: string

    Stable identifier for the team

  • org_id
    Type: string

    Identifier of the owning organization

  • name
    Type: string

    Display name (e.g. "General", "London")

  • slug
    Type: string

    URL-safe slug, unique within the org

  • is_system
    Type: boolean

    True when this is the org's system team. Its slug is locked and the row cannot be deleted; name and other fields remain editable.

  • registrant_contact
    Type: object · Contact

    Embedded registrant contact. Required on live teams; clearing on update is rejected. Null only on pre-backfill rows.

    • object
      Type: string

      Resource type identifier, always "contact".

    • id
      Type: string

      Stable identifier for the contact.

    • org_id
      Type: string

      Identifier of the owning organization.

    • kind
      Type: string · contact.ContactKindenum

      Contact shape: "member" (derived from user + location + optional phone) or "external" (free-form).

      values
      • member = KindMember
      • external = KindExternal
    • user_id
      Type: string

      Identifier of the linked user. Present on member contacts only.

    • phone_id
      Type: string

      Identifier of the linked personal phone. Optional on member contacts; when absent the snapshot's phone is composed from the location's office phone. Always null on external contacts.

    • first_name
      Type: string

      Registrant first name.

    • last_name
      Type: string

      Registrant last name.

    • org_name
      Type: string

      Registrant organization name. Derived from the org's legal name on member contacts; free-form on external contacts.

    • email
      Type: string

      Registrant email address.

    • phone
      Type: string

      Registrant phone in canonical E.164 form.

    • fax
      Type: string

      Registrant fax in canonical E.164 form. Optional; many registries accept an empty value.

    • street1
      Type: string

      First line of the street address.

    • street2
      Type: string

      Second line of the street address. Optional.

    • city
      Type: string

      City or locality.

    • region
      Type: string

      State, province, or administrative region.

    • postal_code
      Type: string

      Postal or ZIP code.

    • country_code
      Type: string

      ISO 3166-1 alpha-2 country code.

    • disclose
      Type: boolean

      Per-contact privacy flag submitted to the registry. True (default) permits the registry to disclose the registrant payload via WHOIS/RDAP; false requests redaction. Not derived from upstream; operator-editable on both kinds.

    • verification_status
      Type: string · contact.VerificationStatusenum

      Explicit verification state of the contact: "unverified" or "verified". Member contacts are stamped "verified" at create time because their snapshot is composed from already-validated upstream rows; external contacts start "unverified" and transition only via the verification flow. Not operator-editable via PATCH.

      values
      • unverified = StatusUnverified
      • verified = StatusVerified
    • is_active
      Type: boolean

      Whether the contact is available for assignment to new team role slots. Defaults to true; flipping to false is the reversible operator switch above soft-delete. A contact currently referenced by any team's role slot cannot be deactivated until the slot is reassigned or cleared.

    • verified_at
      Type: string

      Timestamp of the last successful verification, in RFC 3339 UTC form. Supporting observability for verification_status; null when the contact has never been verified.

    • location
      Type: object · OrgLocation

      Full linked organization location. Present on member contacts; null on external contacts and on member contacts whose location has been deleted.

    • created_at
      Type: string

      Creation timestamp in RFC 3339 UTC form.

    • updated_at
      Type: string

      Last-update timestamp in RFC 3339 UTC form.

  • admin_contact
    Type: object · Contact

    Embedded admin contact. Required on live teams; clearing on update is rejected. Null only on pre-backfill rows.

    • object
      Type: string

      Resource type identifier, always "contact".

    • id
      Type: string

      Stable identifier for the contact.

    • org_id
      Type: string

      Identifier of the owning organization.

    • kind
      Type: string · contact.ContactKindenum

      Contact shape: "member" (derived from user + location + optional phone) or "external" (free-form).

      values
      • member = KindMember
      • external = KindExternal
    • user_id
      Type: string

      Identifier of the linked user. Present on member contacts only.

    • phone_id
      Type: string

      Identifier of the linked personal phone. Optional on member contacts; when absent the snapshot's phone is composed from the location's office phone. Always null on external contacts.

    • first_name
      Type: string

      Registrant first name.

    • last_name
      Type: string

      Registrant last name.

    • org_name
      Type: string

      Registrant organization name. Derived from the org's legal name on member contacts; free-form on external contacts.

    • email
      Type: string

      Registrant email address.

    • phone
      Type: string

      Registrant phone in canonical E.164 form.

    • fax
      Type: string

      Registrant fax in canonical E.164 form. Optional; many registries accept an empty value.

    • street1
      Type: string

      First line of the street address.

    • street2
      Type: string

      Second line of the street address. Optional.

    • city
      Type: string

      City or locality.

    • region
      Type: string

      State, province, or administrative region.

    • postal_code
      Type: string

      Postal or ZIP code.

    • country_code
      Type: string

      ISO 3166-1 alpha-2 country code.

    • disclose
      Type: boolean

      Per-contact privacy flag submitted to the registry. True (default) permits the registry to disclose the registrant payload via WHOIS/RDAP; false requests redaction. Not derived from upstream; operator-editable on both kinds.

    • verification_status
      Type: string · contact.VerificationStatusenum

      Explicit verification state of the contact: "unverified" or "verified". Member contacts are stamped "verified" at create time because their snapshot is composed from already-validated upstream rows; external contacts start "unverified" and transition only via the verification flow. Not operator-editable via PATCH.

      values
      • unverified = StatusUnverified
      • verified = StatusVerified
    • is_active
      Type: boolean

      Whether the contact is available for assignment to new team role slots. Defaults to true; flipping to false is the reversible operator switch above soft-delete. A contact currently referenced by any team's role slot cannot be deactivated until the slot is reassigned or cleared.

    • verified_at
      Type: string

      Timestamp of the last successful verification, in RFC 3339 UTC form. Supporting observability for verification_status; null when the contact has never been verified.

    • location
      Type: object · OrgLocation

      Full linked organization location. Present on member contacts; null on external contacts and on member contacts whose location has been deleted.

    • created_at
      Type: string

      Creation timestamp in RFC 3339 UTC form.

    • updated_at
      Type: string

      Last-update timestamp in RFC 3339 UTC form.

  • tech_contact
    Type: object · Contact

    Embedded technical contact. Optional; null when unset.

    • object
      Type: string

      Resource type identifier, always "contact".

    • id
      Type: string

      Stable identifier for the contact.

    • org_id
      Type: string

      Identifier of the owning organization.

    • kind
      Type: string · contact.ContactKindenum

      Contact shape: "member" (derived from user + location + optional phone) or "external" (free-form).

      values
      • member = KindMember
      • external = KindExternal
    • user_id
      Type: string

      Identifier of the linked user. Present on member contacts only.

    • phone_id
      Type: string

      Identifier of the linked personal phone. Optional on member contacts; when absent the snapshot's phone is composed from the location's office phone. Always null on external contacts.

    • first_name
      Type: string

      Registrant first name.

    • last_name
      Type: string

      Registrant last name.

    • org_name
      Type: string

      Registrant organization name. Derived from the org's legal name on member contacts; free-form on external contacts.

    • email
      Type: string

      Registrant email address.

    • phone
      Type: string

      Registrant phone in canonical E.164 form.

    • fax
      Type: string

      Registrant fax in canonical E.164 form. Optional; many registries accept an empty value.

    • street1
      Type: string

      First line of the street address.

    • street2
      Type: string

      Second line of the street address. Optional.

    • city
      Type: string

      City or locality.

    • region
      Type: string

      State, province, or administrative region.

    • postal_code
      Type: string

      Postal or ZIP code.

    • country_code
      Type: string

      ISO 3166-1 alpha-2 country code.

    • disclose
      Type: boolean

      Per-contact privacy flag submitted to the registry. True (default) permits the registry to disclose the registrant payload via WHOIS/RDAP; false requests redaction. Not derived from upstream; operator-editable on both kinds.

    • verification_status
      Type: string · contact.VerificationStatusenum

      Explicit verification state of the contact: "unverified" or "verified". Member contacts are stamped "verified" at create time because their snapshot is composed from already-validated upstream rows; external contacts start "unverified" and transition only via the verification flow. Not operator-editable via PATCH.

      values
      • unverified = StatusUnverified
      • verified = StatusVerified
    • is_active
      Type: boolean

      Whether the contact is available for assignment to new team role slots. Defaults to true; flipping to false is the reversible operator switch above soft-delete. A contact currently referenced by any team's role slot cannot be deactivated until the slot is reassigned or cleared.

    • verified_at
      Type: string

      Timestamp of the last successful verification, in RFC 3339 UTC form. Supporting observability for verification_status; null when the contact has never been verified.

    • location
      Type: object · OrgLocation

      Full linked organization location. Present on member contacts; null on external contacts and on member contacts whose location has been deleted.

    • created_at
      Type: string

      Creation timestamp in RFC 3339 UTC form.

    • updated_at
      Type: string

      Last-update timestamp in RFC 3339 UTC form.

  • billing_contact
    Type: object · Contact

    Embedded billing contact. Optional; null when unset.

    • object
      Type: string

      Resource type identifier, always "contact".

    • id
      Type: string

      Stable identifier for the contact.

    • org_id
      Type: string

      Identifier of the owning organization.

    • kind
      Type: string · contact.ContactKindenum

      Contact shape: "member" (derived from user + location + optional phone) or "external" (free-form).

      values
      • member = KindMember
      • external = KindExternal
    • user_id
      Type: string

      Identifier of the linked user. Present on member contacts only.

    • phone_id
      Type: string

      Identifier of the linked personal phone. Optional on member contacts; when absent the snapshot's phone is composed from the location's office phone. Always null on external contacts.

    • first_name
      Type: string

      Registrant first name.

    • last_name
      Type: string

      Registrant last name.

    • org_name
      Type: string

      Registrant organization name. Derived from the org's legal name on member contacts; free-form on external contacts.

    • email
      Type: string

      Registrant email address.

    • phone
      Type: string

      Registrant phone in canonical E.164 form.

    • fax
      Type: string

      Registrant fax in canonical E.164 form. Optional; many registries accept an empty value.

    • street1
      Type: string

      First line of the street address.

    • street2
      Type: string

      Second line of the street address. Optional.

    • city
      Type: string

      City or locality.

    • region
      Type: string

      State, province, or administrative region.

    • postal_code
      Type: string

      Postal or ZIP code.

    • country_code
      Type: string

      ISO 3166-1 alpha-2 country code.

    • disclose
      Type: boolean

      Per-contact privacy flag submitted to the registry. True (default) permits the registry to disclose the registrant payload via WHOIS/RDAP; false requests redaction. Not derived from upstream; operator-editable on both kinds.

    • verification_status
      Type: string · contact.VerificationStatusenum

      Explicit verification state of the contact: "unverified" or "verified". Member contacts are stamped "verified" at create time because their snapshot is composed from already-validated upstream rows; external contacts start "unverified" and transition only via the verification flow. Not operator-editable via PATCH.

      values
      • unverified = StatusUnverified
      • verified = StatusVerified
    • is_active
      Type: boolean

      Whether the contact is available for assignment to new team role slots. Defaults to true; flipping to false is the reversible operator switch above soft-delete. A contact currently referenced by any team's role slot cannot be deactivated until the slot is reassigned or cleared.

    • verified_at
      Type: string

      Timestamp of the last successful verification, in RFC 3339 UTC form. Supporting observability for verification_status; null when the contact has never been verified.

    • location
      Type: object · OrgLocation

      Full linked organization location. Present on member contacts; null on external contacts and on member contacts whose location has been deleted.

    • created_at
      Type: string

      Creation timestamp in RFC 3339 UTC form.

    • updated_at
      Type: string

      Last-update timestamp in RFC 3339 UTC form.

  • member_preview
    Type: object · TeamMemberPreview

    Capped preview of the team's most-recently-active members, plus the team's full member count. Always present; empty for newly created teams or when preview enrichment fails.

    • object
      Type: string

      Resource type identifier, always "team_member_preview"

    • items
      Type: array object[] · TeamMember[]

      Up to PreviewMemberLimit members, ordered by most-recently-active first.

      A team membership. Identified by the (team_id, user) pair.

    • total_count
      Type: integer

      Total number of members in the team. May exceed len(items).

  • created_at
    Type: string

    Creation timestamp in RFC 3339 UTC form

  • updated_at
    Type: string

    Last-update timestamp in RFC 3339 UTC form