Get workspace profile
Get the profile of the granted workspace: company name, contact email, plan, brand color, business address, logo URL, and the company profile of proposals (license, insurance, founding year, certifications, reviews, about, terms, payment schedule, warranty and allowance defaults). Change it with roofkit.workspace.profile.update.
Argumentos
Esta herramienta no recibe argumentos.
List workspace members
List workspace members.
Argumentos
Esta herramienta no recibe argumentos.
Get billing summary
Read billing summary. Checkout and portal return Stripe handoff URLs.
Argumentos
Esta herramienta no recibe argumentos.
Open ownership transfer
Return a Settings handoff URL for ownership transfer. Recent auth lives in the app.
Argumentos
Esta herramienta no recibe argumentos.
Update workspace profile
Change the workspace profile with a partial update: company name, brand color, business address, and fields of the company profile. The server merges the update into the stored profile. A field you leave out keeps its value, reviews and warranty_defaults merge their own fields, a list replaces the whole list, and null clears a text field. The change is live at once: sites and emails show the new name and color, and the next proposal publish copies the company profile. Read the current values with roofkit.workspace.profile.get. The logo changes in Settings at logo_handoff_url.
Argumentos
string
Como máximo 80 caracteres.
string
string
The full street address of the company. Como máximo 500 caracteres.
object
Fields of the company profile of proposals, with the keys of company_profile in roofkit.workspace.profile.get. price is dollars per unit.
List member groups
List the member groups of the workspace: role groups first, then custom groups. Each group has its id, name, kind, role_key, member_count, permission levels, and whether its members read financial analytics.
Argumentos
Esta herramienta no recibe argumentos.
List workspace invitations
List the pending invitations of the workspace that have not expired, newest first: id, email, role, expires_at, created_at, and last_sent_at. Revoke one with roofkit.workspace.invitations.revoke.
Argumentos
Esta herramienta no recibe argumentos.
Create workspace invitation
Invite a person to the workspace with a role. RoofKit sends the invitation email to that address at once, with a join link that expires in 7 days. Confirm the email address and the role with the user first. You can grant your own role or a lower one: an Admin invites any role, a Manager invites manager, sales, or guest. A pending invitation holds a seat of the plan. An address that is already a member or already has a pending invitation answers CONFLICT. A retry with the same idempotency_key returns the first answer and sends no second email. Returns the invitation (id, masked_email, role, expires_at) and email_sent. Role changes and member removal stay in Settings: use roofkit.workspace.members.handoff.
Argumentos
string
requerido
Como máximo 254 caracteres.
string
requerido
Valores permitidos:
admin, manager, sales, guest.string
requerido
Revoke workspace invitation
Revoke a pending invitation, so its join link stops working and its seat is free again. Confirm with the user first. The person gets no email. Invite the address again with roofkit.workspace.invitations.create. An invitation that is already accepted or revoked answers CONFLICT.
Argumentos
string
requerido
The id from roofkit.workspace.invitations.list.
string
requerido
Add group members
Add workspace members to a custom group. Ids that are already members stay as they are. Each id must be an active member of the workspace. When the group has projects, adding members needs the Permissions by team feature of the plan. Role groups follow the workspace role and refuse member changes. Only an Admin changes a group that grants financial access or raises permission levels. A group holds at most 500 members. Changes are live at once: the members gain or lose the access of the group on their next request. Returns the group with its new version, member_user_ids, and the ids that changed.
Argumentos
string
requerido
The custom group id from roofkit.workspace.groups.list.
string[]
requerido
Member user ids from roofkit.workspace.members.list.
integer
The group version you read. When it differs, the call changes nothing and answers CONFLICT.
Remove group members
Remove members from a custom group. The members stay in the workspace. Ids that are not in the group are skipped. Role groups follow the workspace role and refuse member changes. Only an Admin changes a group that grants financial access or raises permission levels. A group holds at most 500 members. Changes are live at once: the members gain or lose the access of the group on their next request. Returns the group with its new version, member_user_ids, and the ids that changed.
Argumentos
string
requerido
The custom group id from roofkit.workspace.groups.list.
string[]
requerido
Member user ids from roofkit.workspace.members.list.
integer
The group version you read. When it differs, the call changes nothing and answers CONFLICT.
Open People settings
Return the Settings > People URL. A role change and the removal of a member from the workspace stay in the app.
Argumentos
Esta herramienta no recibe argumentos.