Skip to main content
Pivot logo
  • Category: team collaboration
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 71
  • Triggers: 0
  • Slug: PIVOT
  • Version: 20261101_00

Tools

Slug: PIVOT_ADD_BLOCK_RESPONSE_ATTACHMENTAttach an existing Pivot file to a block response.

Input Parameters

string
required
Pivot file UUID to attach to the block response.
string
required
Block response UUID to which the file will be attached.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ADD_GROUP_MEMBERSAdd one or more existing Pivot users to a group.

Input Parameters

string
required
Group UUID to which the users will be added.
array
required
User UUIDs to add to the group.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ADD_GROUP_TO_SPACEGrant an existing Pivot group access to a space with specified space roles.

Input Parameters

string
required
Group UUID to grant access to the space.
array
required
Space-role UUIDs to grant to the group.
string
required
Space UUID to which the group will be granted access.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ADD_ROOM_MEMBERSAdd one or more existing Pivot users to a room with a shared role. The Pivot API exposes no undo path for this membership change.

Input Parameters

string ("ROOM_ROLE_UNSPECIFIED" | "ROOM_ROLE_HOST" | "ROOM_ROLE_PARTICIPANT")
required
Room role to grant to every specified user.
string
required
Room UUID to which the users will be added.
array
required
User UUIDs to add to the room.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ADD_SPACE_LABELSAdd one or more labels to a Pivot space without removing labels already assigned to it.

Input Parameters

string
required
Space UUID to which the labels will be added.
array
required
Label UUIDs to add. Existing labels remain assigned; use the remove space label action to remove one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ADD_SPACE_MEMBERSAdd one or more existing Pivot users to a space, optionally assigning space roles and member titles. The response can include individual failures alongside created memberships.

Input Parameters

array
required
Users to add, with optional role assignments and titles.
string
required
Space UUID to which the users will be added.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_COPY_SPACEStart an asynchronous copy of a Pivot space. A successful response only means the copy was accepted. Poll the space operation-status endpoint with the same source space_id and returned operation_id until status is succeeded or failed; on success, new_space_id identifies the copy.

Input Parameters

string
required
Name of the new space or organization template.
string
required
Source space UUID to copy. Use this same ID when polling the returned operation_id.
string ("not_template" | "organization")
Omit or use not_template to create an ordinary space; use organization to create an organization template.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_BLOCK_RESPONSECreate a Pivot block response from plain text, or use advanced rich content for formatting; optionally create it as a reply.

Input Parameters

string
Plain text for the response. Use this for the common unformatted-text path.
string
required
Block UUID for which to create a response.
object
Advanced Pivot Lexical document for formatted content. Use either this or text, not both.
string
Parent response UUID when creating a reply to another block response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_BLOCK_SHARING_RULECreate a sharing rule that grants a subject access to a Pivot block.

Input Parameters

string ("BLOCK_SHARING_LEVEL_UNSPECIFIED" | "BLOCK_SHARING_LEVEL_NOT_SHARED" | "BLOCK_SHARING_LEVEL_VIEW" | "BLOCK_SHARING_LEVEL_VIEW_AND_COMMENT" | "BLOCK_SHARING_LEVEL_EDIT_CONTENT" | "BLOCK_SHARING_LEVEL_EDIT_STRUCTURE_AND_CONTENT" | "BLOCK_SHARING_LEVEL_FULL_CONTROL")
required
Access level to grant to the sharing subject.
object
required
Provider-defined sharing subject. Set any documented user, group, space role, membership tier, or space identifiers that apply.
string
required
Block UUID for which to create the sharing rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_LABELCreate a label in a Pivot organization. Pivot’s label delete endpoint was observed returning an error without removing the label, so create only labels that may safely remain in the organization.

Input Parameters

string
required
Human-readable name for the label.
string
required
Label color in #RRGGBB format.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_ROOMCreate a Pivot chat, direct, post, audio, video, or streaming room. Pivot does not document a room-delete endpoint, so this creation cannot be safely reversed; create only rooms that may remain in the workspace.

Input Parameters

string
required
Human-readable name for the new room.
string
Topic shown to room participants.
string ("ROOM_TYPE_AUDIO" | "ROOM_TYPE_CHAT" | "ROOM_TYPE_DIRECT" | "ROOM_TYPE_POST" | "ROOM_TYPE_STREAMING" | "ROOM_TYPE_UNSPECIFIED" | "ROOM_TYPE_VIDEO")
required
Type of room to create.
boolean
Whether the room starts recording automatically.
boolean
Whether members may download room recordings.
boolean
Whether new recordings are hidden from room members by default.
boolean
Whether recording transcripts are hidden from room members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_SPACECreate a blank Pivot space or organization template synchronously, or create an independent space from a template. A template-based request returns the new space immediately and may include operation_id while content is copied asynchronously; poll the space operation-status endpoint until succeeded or failed. To duplicate an ordinary space, use Pivot’s copy-space action instead.

Input Parameters

string
Space name. Required for a blank space or organization template; optional as a name override when template_space_id is set.
array
Tags to assign to the new space.
string ("SPACE_TYPE_COMMUNITY" | "SPACE_TYPE_COURSE" | "SPACE_TYPE_KNOWLEDGE" | "SPACE_TYPE_OTHER" | "SPACE_TYPE_PERSONAL" | "SPACE_TYPE_PROJECT" | "SPACE_TYPE_TEAM" | "SPACE_TYPE_UNSPECIFIED")
Space type. Required when template_space_id is omitted and inherited from the source template otherwise.
string
Pivot icon name displayed for the space.
Secret-link access policy for the new space.
string ("not_template" | "organization")
Set organization to create an organization template; omitted or not_template creates an ordinary space.
string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED")
Public access policy for the new space.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.
string
Custom type label used with SPACE_TYPE_OTHER.
string
Template space UUID to copy into an independent new space. Only name may also be supplied; content copying completes asynchronously.
string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED")
Organization-wide access policy for the new space.
boolean
Whether progress tracking is enabled for the space.
boolean
Whether blocks may be shared directly with individual users.
boolean
Whether blocks may be shared publicly.
boolean
Whether blocks may be shared with other organization members.
boolean
Whether invitations are limited to people who are already members of the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_SPACE_ROLECreate a custom role in a Pivot space with an explicit set of permissions. Pivot does not document an endpoint for deleting space roles, so create only roles that may safely remain in the space.

Input Parameters

string
required
Human-readable name for the custom space role.
string ("SPACE_ROLE_TYPE_FULL" | "SPACE_ROLE_TYPE_GUEST" | "SPACE_ROLE_TYPE_UNSPECIFIED")
Role type; omit to use Pivot’s default type.
string
required
Space UUID in which to create the custom role.
array
required
Permissions granted by the custom space role.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_SUBGOALCreate a goal directly under an existing Pivot goal. Requires edit access to the parent and uses request_id as an idempotency key scoped to the caller and parent.

Input Parameters

string
required
Plain-text title of the new subgoal.
string
required
Caller-generated UUID idempotency key. Reuse it with the same parent and title when retrying an uncertain request.
string
required
Parent goal block UUID under which to create the subgoal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_CREATE_WEBHOOKCreate a Pivot webhook for an organization and return its one-time signing secret. Store the secret securely because it is not returned by later reads.

Input Parameters

string
required
Human-readable name for the webhook.
string
Optional human-readable description of the webhook.
string
required
Public HTTPS callback URL that receives webhook deliveries.
array
required
Webhook event subscriptions to create.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_BLOCK_RESPONSEDelete a response from a Pivot block by its response UUID.

Input Parameters

string
required
Block response UUID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_BLOCK_RESPONSE_ATTACHMENTDelete a file attached to a block response by attachment UUID.

Input Parameters

string
required
Block response attachment UUID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_BLOCK_SHARING_RULEDelete a sharing rule from a Pivot block by sharing-rule UUID.

Input Parameters

string
required
Block UUID whose sharing rule will be deleted.
string
required
Sharing-rule UUID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_LABELPermanently delete a Pivot label by its label UUID. Pivot returned HTTP 500 without deleting the build account’s test label, so treat a provider error as no deletion and verify the label is absent after success.

Input Parameters

string
required
Label UUID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_ROOM_MESSAGEDelete a sent Pivot room message. Provide sent_at for a non-thread message or thread_root_message_id for a message in a thread.

Input Parameters

string
required
Room UUID containing the message.
string
Message send timestamp used to locate a non-thread message. Provide this or thread_root_message_id.
string
required
Message UUID to delete.
string
Recording UUID whose partition contains the recording comment.
string
Root message UUID used to locate a message in a thread. Provide this or sent_at.
string
Immediate parent message UUID when deleting a threaded reply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_SPACEPermanently delete a Pivot space or template using its ordinary space lifecycle.

Input Parameters

string
required
Space or template UUID to delete.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_USERPermanently delete a Pivot user account, not merely remove a space membership. Pivot allows this only when the user’s email is verified by the specified organization and by no other organization. This cannot be undone and deletes the user across all organizations.

Input Parameters

string
required
Pivot user identifier to delete, such as a user UUID. This identifies the user account, not a space-member UUID or organization membership; deletion is permanent and affects every organization.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_USER_OR_REMOVE_MEMBERSHIPDelete a Pivot user globally when the specified organization verified that user. Otherwise, remove the user’s memberships only from the specified organization. This is destructive: the same call can permanently delete the user across Pivot, and user_deleted reports which outcome occurred.

Input Parameters

string
required
User UUID to delete globally or remove from the organization.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_DELETE_WEBHOOKPermanently delete a Pivot webhook by its webhook UUID.

Input Parameters

string
required
Webhook UUID to delete.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_BLOCKReturn a block by ID, optionally including all visible descendant blocks.

Input Parameters

string
required
Block UUID to retrieve.
boolean
Whether to include all visible descendant blocks in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_ROOMReturn a Pivot room by its ID.

Input Parameters

string
required
Room UUID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_ROOM_MESSAGERetrieve one Pivot room message by its ID and send timestamp. Thread replies also require both thread locator IDs, and recording comments require the parent recording ID.

Input Parameters

string
required
Room UUID containing the message.
string
required
Message send timestamp required to locate every message.
string
required
Message UUID to retrieve.
string
Recording UUID required when the message is a recording comment.
string
Root message UUID for a threaded reply. Provide it together with thread_parent_message_id.
string
Immediate parent message UUID for a threaded reply. Provide it together with thread_root_message_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_ROOM_RECORDINGReturn a specific Pivot room recording using its room ID, recording ID, and creation timestamp, including transcript, chapter, summary, and caption assets when available.

Input Parameters

string
required
Room UUID containing the recording.
string
required
Recording creation timestamp required to locate the recording.
string
required
Recording UUID within the room.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_SPACEReturn a Pivot space by ID with its settings, roles, member summaries, and labels. Response-only access tokens are removed. The direct endpoint’s member_count can be 0 even when members exist; use list spaces or list space members when an authoritative count is required.

Input Parameters

string
required
Space UUID to retrieve.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_SPACE_OPERATIONGet the status of an asynchronous Pivot space copy or template application. Poll until status is succeeded or failed. For Copy Space, pass the source space_id used in the copy request; for Create Space from a template, pass the new space.id returned by Create Space.

Input Parameters

string
required
For Copy Space, the source space UUID passed to the copy request. For Create Space from a template, the new space UUID returned as space.id.
string
required
Asynchronous operation UUID returned by Copy Space or Create Space.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_GET_USER_CONTEXTReturn a Pivot user’s profile, space memberships, and groups within an organization. The response excludes the provider’s presence token.

Input Parameters

string
required
User identifier accepted by Pivot, such as a user UUID.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_HIDE_SPACEHide an existing Pivot space from view. The Pivot API exposes no undo path for hiding a space.

Input Parameters

string
required
Space UUID to hide from view.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_INVITE_TO_ROOMInvite people to a Pivot room by email. A successful call creates room invitations and sends externally visible invitation emails to every address.

Input Parameters

object
required
Invitation details. Pivot emails every recipient and creates a room invitation with the selected role.
string
required
Room UUID to which the recipients will be invited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_INVITE_TO_SPACEInvite people to a Pivot space by email. A successful call sends externally visible invitation emails to new users and adds existing Pivot users directly to the space with the specified roles and groups.

Input Parameters

array
required
Invitation details, one entry per email recipient.
string
required
Space UUID to which the recipients will be invited or added.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_BLOCK_RESPONSESReturn the responses attached to a Pivot block.

Input Parameters

string
required
Block UUID whose responses to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_BLOCK_SHARING_RULESReturn the sharing rules configured for a Pivot block.

Input Parameters

string
required
Block UUID whose sharing rules should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_GROUP_MEMBERSReturn the users in a specified Pivot group.

Input Parameters

string
required
Group UUID whose members to return.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_GROUPSReturn one page of groups in a Pivot organization.

Input Parameters

integer
Maximum number of groups to return in this page.
string
Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_LABELSReturn the labels configured in a Pivot organization.

Input Parameters

string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_ORGANIZATION_USERSReturn one page of users in a Pivot organization. Pass next_cursor from the preceding response unchanged to continue listing users.

Input Parameters

integer
Maximum number of users to return in this page.
string
Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_ROOM_MESSAGESReturn one page of room messages, newest first. On the first call, provide the room ID and its created_at timestamp from Get Room. To continue through the current and older history windows, call again with only next_cursor; pagination stops automatically at the room’s creation boundary.

Input Parameters

integer
Maximum number of messages to return in this page.
string
Room UUID whose messages should be returned.
string
Opaque continuation token returned by a previous call. For continuation, pass only this token; it retains the room, limit, and room creation timestamp from the first call.
string
Room creation timestamp returned by Get Room. Required on the first call so pagination can stop at the oldest possible history window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_ROOM_RECORDINGSReturn one page of recordings for a Pivot room, including transcripts and other recording assets.

Input Parameters

integer
Maximum number of recordings to return in this page.
string
required
Room UUID whose recordings should be returned.
string
Opaque continuation token returned by a previous call. Omit for the first page and pass it back unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_ASSIGNMENT_BLOCKSReturn all assignment blocks in a Pivot space.

Input Parameters

string
required
Space UUID whose assignment blocks to return.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_DESCRIPTION_BLOCKSReturn a space’s description blocks and all of their descendants.

Input Parameters

string
required
Space UUID whose description blocks should be returned.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_HOME_BLOCKSReturn the blocks displayed on a Pivot space home.

Input Parameters

string
required
Space UUID whose home blocks should be returned.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_MEMBERSReturn one page of members in a Pivot space. By default, only active members are returned; use status to include other membership states.

Input Parameters

integer
Maximum number of members to return in this page.
array
Membership statuses to include. Repeat the status query parameter for multiple states. Omit to return active members only.
string
required
Space UUID whose members should be returned.
string
Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_ROLESReturn the roles available in a Pivot space.

Input Parameters

string
required
Space UUID whose available roles should be returned.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACE_ROOM_BLOCKSReturn all room blocks and their parallel room metadata in a Pivot space.

Input Parameters

string
required
Space UUID whose room blocks should be returned.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_SPACESReturn one page of spaces visible in a Pivot organization. Supports exact status, type, template, label, name-search, and sort filters. Templates are excluded and only active spaces are returned unless those filters are set.

Input Parameters

integer
Maximum number of spaces to return in this page.
string ("active" | "archived" | "deleted" | "hidden")
Lifecycle status to include: active, archived, deleted, or hidden. Omit to return active spaces only.
string ("created_at_asc" | "created_at_desc" | "last_activity_asc" | "last_activity_desc")
Order spaces by creation time or last activity, ascending or descending.
array
Label UUIDs used to filter spaces.
string
Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged.
array
Space types to include.
string
Case-insensitive text to match against space names.
array
Template types to include. Templates are excluded by default; include organization or global to list templates.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.
boolean
When true, exclude spaces carrying any label_ids; when false, include spaces matching label_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_THREAD_MESSAGESReturn one page of messages in a Pivot thread, oldest first; for nested threads, identify the thread using the top-level parent message. Continue with next_cursor until has_more is false.

Input Parameters

integer
Maximum number of thread messages to return in this page.
string
required
Room UUID containing the message thread.
string
required
Parent message UUID identifying the thread.
string
Opaque continuation token returned by a previous call. Omit it for the first page and pass it back unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_WEBHOOK_LOGSReturn one page of delivery logs for a Pivot webhook. Pivot retains webhook logs for 30 days.

Input Parameters

integer
Maximum number of webhook delivery logs to return in this page.
string
required
Webhook UUID whose delivery logs should be returned.
string
Opaque next_before_time value returned by a previous response. Omit for the first page and pass it back as next_cursor unchanged.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_LIST_WEBHOOKSReturn webhooks for a Pivot organization, optionally filtering by a case-insensitive substring of the webhook name.

Input Parameters

string
Optional case-insensitive substring match on webhook name.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REMOVE_GROUP_MEMBERSRemove one or more users from a Pivot group.

Input Parameters

string
required
Group UUID from which to remove members.
array
User UUIDs to remove from the group.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REMOVE_SPACE_LABELRemove one label from a Pivot space by space and label UUID.

Input Parameters

string
required
Label UUID to remove from the space.
string
required
Space UUID from which to remove the label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REMOVE_SPACE_MEMBERRemove a user from a Pivot space by space-member UUID.

Input Parameters

string
required
Space UUID containing the member to remove.
string
required
Space-member UUID to remove, not the underlying user UUID.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REQUEST_RECORDING_DOWNLOADEnsure a downloadable MP4 rendition exists for a Pivot room recording. When ready is false, the rendition is still being prepared; retry shortly with the same room_id, recording_id, and created_at. The direct download URL is returned when ready is true.

Input Parameters

string
required
Room UUID containing the recording.
string
required
Recording creation timestamp required to locate the recording.
string
required
Recording UUID within the room.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REVOKE_ORGANIZATION_INVITERevoke a Pivot organization invitation by its invitation ID and email address.

Input Parameters

string
required
Email address identifying the invitation.
string
required
Invitation UUID to revoke.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REVOKE_ROOM_INVITERevoke a Pivot room invitation by room ID and email address.

Input Parameters

string
required
Email address identifying the room invitation to revoke.
string
required
Room UUID whose invitation will be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_REVOKE_SPACE_INVITERevoke a Pivot space invitation by organization, space, and email address.

Input Parameters

string
required
Email address identifying the space invitation to revoke.
string
required
Space UUID whose invitation will be revoked.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_ROTATE_WEBHOOK_SECRETRotate the organization-wide webhook signing secret used for future Pivot webhooks. Existing webhooks retain the current secret. Store the returned one-time secret securely.

Input Parameters

string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_SEND_ROOM_MESSAGESend plain text or an advanced rich-content document to a Pivot room, optionally with file attachments or as a thread, inline, or recording reply. Sending delivers the message to room participants and cannot be safely reversed.

Input Parameters

string
Plain text to send. Use this for ordinary messages; provide exactly one of text or rich_content.
string ("MESSAGE_TYPE_AUDIO_CALL" | "MESSAGE_TYPE_UNSPECIFIED" | "MESSAGE_TYPE_VIDEO_CALL")
Message type, including audio or video call messages.
string
required
Room UUID to which the message will be sent.
array
Pivot file UUIDs to attach to the message.
object
Advanced Pivot Lexical document for formatting, links, or mentions. Provide exactly one of rich_content or text.
string
Recording UUID when the message is a recording comment.
string
Send timestamp of the thread’s root message. Include it when replying to a thread and the root message’s sent_at is unavailable.
string
Send timestamp of the message being replied to inline.
string
Root message UUID for a message in a thread.
string
Message UUID being replied to inline.
string
Immediate parent message UUID for a threaded reply.
string
Thread-root message UUID for an inline reply inside a thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_SUBMIT_BLOCK_RESPONSEIrreversibly submit a Pivot block response. This sends or marks an existing draft response as submitted and cannot be safely undone.

Input Parameters

string
required
Block response UUID to submit irreversibly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_BLOCKUpdate exactly one property of a Pivot block: its hide time, unhide time, or space-member sharing level.

Input Parameters

string
required
Block UUID to update.
string
Timestamp after which the block becomes hidden. Use the current time to hide it immediately.
string
Timestamp after which the block becomes visible again. Use the current time to show it immediately.
string ("BLOCK_SHARING_LEVEL_NOT_SHARED" | "BLOCK_SHARING_LEVEL_VIEW" | "BLOCK_SHARING_LEVEL_VIEW_AND_COMMENT" | "BLOCK_SHARING_LEVEL_EDIT_CONTENT" | "BLOCK_SHARING_LEVEL_EDIT_STRUCTURE_AND_CONTENT" | "BLOCK_SHARING_LEVEL_FULL_CONTROL")
Access granted to members of the block’s own space for this block and its descendants. Use BLOCK_SHARING_LEVEL_NOT_SHARED to disable access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_BLOCK_RESPONSEReplace a Pivot block response with plain text, or use advanced rich content for formatting.

Input Parameters

string
Plain replacement text. Use this for the common unformatted-text path.
string
required
Block response UUID to update.
object
Advanced Pivot Lexical document for formatted replacement content. Use either this or text, not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_BLOCK_SHARING_RULESet the access level for a user, group, space role, membership tier, or space identified by the subject of a sharing rule on a Pivot block.

Input Parameters

string ("BLOCK_SHARING_LEVEL_UNSPECIFIED" | "BLOCK_SHARING_LEVEL_NOT_SHARED" | "BLOCK_SHARING_LEVEL_VIEW" | "BLOCK_SHARING_LEVEL_VIEW_AND_COMMENT" | "BLOCK_SHARING_LEVEL_EDIT_CONTENT" | "BLOCK_SHARING_LEVEL_EDIT_STRUCTURE_AND_CONTENT" | "BLOCK_SHARING_LEVEL_FULL_CONTROL")
required
Access level to apply to the sharing subject.
object
required
Provider-defined sharing subject. Set any documented user, group, space role, membership tier, or space identifiers that apply.
string
required
Block UUID whose sharing rule will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_LABELUpdate the name, color, or both for a Pivot label. Pivot clears the existing color when a name update omits color, so resend the current color to preserve it.

Input Parameters

string
New label name. When changing only the name, also resend the label’s current color because Pivot clears an omitted color.
string
New label color in #RRGGBB format.
string
required
Label UUID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_ROOMUpdate one or more settings for a Pivot room, including its name, topic, type, and recording preferences.

Input Parameters

string
New room name.
string
New room topic shown to participants.
string
required
Room UUID to update.
string ("ROOM_TYPE_UNSPECIFIED" | "ROOM_TYPE_DIRECT" | "ROOM_TYPE_CHAT" | "ROOM_TYPE_POST" | "ROOM_TYPE_AUDIO" | "ROOM_TYPE_VIDEO" | "ROOM_TYPE_STREAMING")
New Pivot room type.
boolean
Whether the room starts recording automatically.
boolean
Whether room members may download recordings.
boolean
Whether new recordings are hidden from room members by default.
boolean
Whether recording transcripts are hidden from room members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_ROOM_MESSAGEReplace a sent Pivot room message with plain text or an advanced rich-content document. sent_at identifies the original message; include thread_root_message_id and thread_parent_message_id for a threaded message, or parent_recording_id for a recording comment.

Input Parameters

string
Plain replacement text. Use this for ordinary messages; provide exactly one of text or rich_content.
string
required
Room UUID containing the message.
string
required
Original message send timestamp required to locate the message.
array
Pivot file UUIDs to retain or attach to the edited message.
string
required
Message UUID to edit.
object
Advanced replacement Pivot Lexical document for formatting, links, or mentions. Provide exactly one of rich_content or text.
string
Recording UUID required when editing a recording comment.
string
Root message UUID required when editing a message in a thread.
string
Immediate parent message UUID when editing a threaded reply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_SPACEUpdate one or more settings or metadata fields for an existing Pivot space. Only provided fields are changed.

Input Parameters

string
New human-readable name for the space.
array
Complete list of tags to set on the space.
string ("SPACE_TYPE_COMMUNITY" | "SPACE_TYPE_COURSE" | "SPACE_TYPE_KNOWLEDGE" | "SPACE_TYPE_OTHER" | "SPACE_TYPE_PERSONAL" | "SPACE_TYPE_PROJECT" | "SPACE_TYPE_TEAM" | "SPACE_TYPE_UNSPECIFIED")
New Pivot space type.
string
required
Space UUID to update.
string
Pivot icon name displayed for the space.
Link-sharing policy for the space.
string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED")
Public-sharing policy for the space.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.
string
Custom type label used when type is SPACE_TYPE_OTHER.
integer
Horizontal cover-photo focal offset.
integer
Vertical cover-photo focal offset.
string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED")
Organization-wide sharing policy for the space.
string
Role UUID assigned by default to new space members.
boolean
Whether progress tracking is enabled for the space.
boolean
Whether blocks may be shared directly with individual users.
boolean
Whether blocks may be shared publicly.
boolean
Whether blocks may be shared with other organization members.
boolean
Whether invitations are limited to people who are already organization members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_SPACE_MEMBERUpdate a Pivot space member’s roles, title, status, or any combination of those fields. The member ID is the space-membership UUID, not a user UUID.

Input Parameters

string
New plain-text title for the member in the space.
string ("SPACE_MEMBER_STATUS_ACTIVE" | "SPACE_MEMBER_STATUS_DELETED" | "SPACE_MEMBER_STATUS_DENIED" | "SPACE_MEMBER_STATUS_LEFT" | "SPACE_MEMBER_STATUS_PROCESSING" | "SPACE_MEMBER_STATUS_REMOVED" | "SPACE_MEMBER_STATUS_REQUESTED" | "SPACE_MEMBER_STATUS_UNSPECIFIED")
New membership status for the space member.
array
Complete list of space-role UUIDs to grant to the member.
string
required
Space UUID containing the member.
string
required
Space-member UUID to update, not the underlying user UUID.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIVOT_UPDATE_WEBHOOKUpdate one or more properties of a Pivot webhook. Supplying subscriptions replaces the webhook’s complete existing subscription set.

Input Parameters

string
New human-readable name for the webhook.
string ("WEBHOOK_STATUS_UNSPECIFIED" | "WEBHOOK_STATUS_ACTIVE" | "WEBHOOK_STATUS_INACTIVE" | "WEBHOOK_STATUS_PAUSED")
New lifecycle status for the webhook.
string
required
Webhook UUID to update.
string
New human-readable description for the webhook.
string
New public HTTPS callback URL that receives webhook deliveries.
array
Complete replacement subscription set. When supplied, Pivot replaces all existing subscriptions; at least one subscription is required.
string
required
The organization’s UUID. Pivot documents no organization-key discovery endpoint or self-service UUID location: organization keys cannot use the personal /v1/me/organizations endpoint. Ask the Pivot organization admin who created or manages the integration in Organization Admin > Integrations to supply the UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not