TeamMember

Somebody's membership of your Bonsai account, and the ids you use to assign work to them.

  • company_member_id
    Type: integer
    required

    Unique identifier for the membership. This is the value write endpoints accept as assignee_member_id or owner_member_id.

  • confirmed_at
    Type: string | nullFormat: date-time
    required

    When the member accepted their invitation, or null while it is still outstanding.

  • deactivated_at
    Type: string | nullFormat: date-time
    required

    When an administrator deactivated the member, or null. A member with a value here has no access, whatever confirmed_at says.

  • declined_at
    Type: string | nullFormat: date-time
    required

    When the member declined their invitation, or null. Never set alongside confirmed_at.

  • email
    Type: string | null
    required

    The member's email address.

  • name
    Type: string | null
    required

    The member's full name, or null before they accept their invitation.

  • permission_profile
    Type: string | null
    required

    Name of the permission profile that decides what the member is allowed to do, for example Owner or Collaborator. null when unset.

  • role
    Type: string | null
    required

    The member's job title, for example Software Engineer. Free text set by your team, null when unset. It carries no authorization meaning — see permission_profile for that.

  • user_id
    Type: integer | null
    required

    Id of the Bonsai user behind the membership, or null for an invitation nobody has accepted yet.