--- canonical_url: "https://docs.composio.dev/toolkits/pivot" markdown_url: "https://docs.composio.dev/toolkits/pivot.md" product: "platform" version: null last_updated: null --- # Pivot Pivot is a team collaboration platform for managing organizations, spaces, rooms, messages, goals, members, and shared work. - **Category:** team collaboration - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 71 - **Triggers:** 0 - **Slug:** `PIVOT` - **Version:** 00000000_00 ## Tools ### Add Block Response Attachment **Slug:** `PIVOT_ADD_BLOCK_RESPONSE_ATTACHMENT` Attach an existing Pivot file to a block response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | Pivot file UUID to attach to the block response. | | `response_id` | string | Yes | Block response UUID to which the file will be attached. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Group Members **Slug:** `PIVOT_ADD_GROUP_MEMBERS` Add one or more existing Pivot users to a group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | Group UUID to which the users will be added. | | `user_ids` | array | Yes | User UUIDs to add to the group. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Group To Space **Slug:** `PIVOT_ADD_GROUP_TO_SPACE` Grant an existing Pivot group access to a space with specified space roles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | Group UUID to grant access to the space. | | `role_ids` | array | Yes | Space-role UUIDs to grant to the group. | | `space_id` | string | Yes | Space UUID to which the group will be granted access. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Room Members **Slug:** `PIVOT_ADD_ROOM_MEMBERS` Add 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role` | string ("ROOM_ROLE_UNSPECIFIED" | "ROOM_ROLE_HOST" | "ROOM_ROLE_PARTICIPANT") | Yes | Room role to grant to every specified user. | | `room_id` | string | Yes | Room UUID to which the users will be added. | | `user_ids` | array | Yes | User UUIDs to add to the room. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Space Labels **Slug:** `PIVOT_ADD_SPACE_LABELS` Add one or more labels to a Pivot space without removing labels already assigned to it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID to which the labels will be added. | | `label_ids` | array | Yes | Label UUIDs to add. Existing labels remain assigned; use the remove space label action to remove one. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Space Members **Slug:** `PIVOT_ADD_SPACE_MEMBERS` Add one or more existing Pivot users to a space, optionally assigning space roles and member titles. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `members` | array | Yes | Users to add, with optional role assignments and titles. | | `space_id` | string | Yes | Space UUID to which the users will be added. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Space **Slug:** `PIVOT_COPY_SPACE` Start 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the new space or organization template. | | `space_id` | string | Yes | Source space UUID to copy. Use this same ID when polling the returned operation_id. | | `template_type` | string ("not_template" | "organization") | No | Omit or use not_template to create an ordinary space; use organization to create an organization template. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Block Response **Slug:** `PIVOT_CREATE_BLOCK_RESPONSE` Create a Pivot block response from plain text, or use advanced rich content for formatting; optionally create it as a reply. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | No | Plain text for the response. Use this for the common unformatted-text path. | | `block_id` | string | Yes | Block UUID for which to create a response. | | `rich_content` | object | No | Advanced Pivot Lexical document for formatted content. Use either this or text, not both. | | `parent_response_id` | string | No | Parent response UUID when creating a reply to another block response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Block Sharing Rule **Slug:** `PIVOT_CREATE_BLOCK_SHARING_RULE` Create a sharing rule that grants a subject access to a Pivot block. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rule` | 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") | Yes | Access level to grant to the sharing subject. | | `subject` | object | Yes | Provider-defined sharing subject. Set any documented user, group, space role, membership tier, or space identifiers that apply. | | `block_id` | string | Yes | Block UUID for which to create the sharing rule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Label **Slug:** `PIVOT_CREATE_LABEL` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the label. | | `color` | string | Yes | Label color in #RRGGBB format. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Room **Slug:** `PIVOT_CREATE_ROOM` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the new room. | | `topic` | string | No | Topic shown to room participants. | | `room_type` | string ("ROOM_TYPE_AUDIO" | "ROOM_TYPE_CHAT" | "ROOM_TYPE_DIRECT" | "ROOM_TYPE_POST" | "ROOM_TYPE_STREAMING" | "ROOM_TYPE_UNSPECIFIED" | "ROOM_TYPE_VIDEO") | Yes | Type of room to create. | | `record_automatically` | boolean | No | Whether the room starts recording automatically. | | `allow_recording_download` | boolean | No | Whether members may download room recordings. | | `hide_recording_by_default` | boolean | No | Whether new recordings are hidden from room members by default. | | `hide_recording_transcript` | boolean | No | Whether recording transcripts are hidden from room members. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Space **Slug:** `PIVOT_CREATE_SPACE` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Space name. Required for a blank space or organization template; optional as a name override when template_space_id is set. | | `tags` | array | No | Tags to assign to the new space. | | `type` | 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") | No | Space type. Required when template_space_id is omitted and inherited from the source template otherwise. | | `icon_name` | string | No | Pivot icon name displayed for the space. | | `link_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Secret-link access policy for the new space. | | `template_type` | string ("not_template" | "organization") | No | Set organization to create an organization template; omitted or not_template creates an ordinary space. | | `public_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Public access policy for the new space. | | `organization_id` | string | Yes | 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. | | `other_type_name` | string | No | Custom type label used with SPACE_TYPE_OTHER. | | `template_space_id` | string | No | Template space UUID to copy into an independent new space. Only name may also be supplied; content copying completes asynchronously. | | `organization_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Organization-wide access policy for the new space. | | `enable_progress_tracking` | boolean | No | Whether progress tracking is enabled for the space. | | `allow_block_sharing_users` | boolean | No | Whether blocks may be shared directly with individual users. | | `allow_block_sharing_public` | boolean | No | Whether blocks may be shared publicly. | | `allow_block_sharing_organization_members` | boolean | No | Whether blocks may be shared with other organization members. | | `only_allow_existing_organization_members` | boolean | No | Whether invitations are limited to people who are already members of the organization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Space Role **Slug:** `PIVOT_CREATE_SPACE_ROLE` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the custom space role. | | `type` | string ("SPACE_ROLE_TYPE_FULL" | "SPACE_ROLE_TYPE_GUEST" | "SPACE_ROLE_TYPE_UNSPECIFIED") | No | Role type; omit to use Pivot's default type. | | `space_id` | string | Yes | Space UUID in which to create the custom role. | | `permissions` | array | Yes | Permissions granted by the custom space role. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Subgoal **Slug:** `PIVOT_CREATE_SUBGOAL` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | Plain-text title of the new subgoal. | | `request_id` | string | Yes | Caller-generated UUID idempotency key. Reuse it with the same parent and title when retrying an uncertain request. | | `parent_block_id` | string | Yes | Parent goal block UUID under which to create the subgoal. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Webhook **Slug:** `PIVOT_CREATE_WEBHOOK` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable name for the webhook. | | `description` | string | No | Optional human-readable description of the webhook. | | `endpoint_url` | string | Yes | Public HTTPS callback URL that receives webhook deliveries. | | `subscriptions` | array | Yes | Webhook event subscriptions to create. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Block Response **Slug:** `PIVOT_DELETE_BLOCK_RESPONSE` Delete a response from a Pivot block by its response UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response_id` | string | Yes | Block response UUID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Block Response Attachment **Slug:** `PIVOT_DELETE_BLOCK_RESPONSE_ATTACHMENT` Delete a file attached to a block response by attachment UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `attachment_id` | string | Yes | Block response attachment UUID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Block Sharing Rule **Slug:** `PIVOT_DELETE_BLOCK_SHARING_RULE` Delete a sharing rule from a Pivot block by sharing-rule UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `block_id` | string | Yes | Block UUID whose sharing rule will be deleted. | | `sharing_rule_id` | string | Yes | Sharing-rule UUID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Label **Slug:** `PIVOT_DELETE_LABEL` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label_id` | string | Yes | Label UUID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Room Message **Slug:** `PIVOT_DELETE_ROOM_MESSAGE` Delete 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `room_id` | string | Yes | Room UUID containing the message. | | `sent_at` | string | No | Message send timestamp used to locate a non-thread message. Provide this or thread_root_message_id. | | `message_id` | string | Yes | Message UUID to delete. | | `parent_recording_id` | string | No | Recording UUID whose partition contains the recording comment. | | `thread_root_message_id` | string | No | Root message UUID used to locate a message in a thread. Provide this or sent_at. | | `thread_parent_message_id` | string | No | Immediate parent message UUID when deleting a threaded reply. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Space **Slug:** `PIVOT_DELETE_SPACE` Permanently delete a Pivot space or template using its ordinary space lifecycle. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space or template UUID to delete. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete User **Slug:** `PIVOT_DELETE_USER` Permanently 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | 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. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete User or Remove Membership **Slug:** `PIVOT_DELETE_USER_OR_REMOVE_MEMBERSHIP` Delete 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | User UUID to delete globally or remove from the organization. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook **Slug:** `PIVOT_DELETE_WEBHOOK` Permanently delete a Pivot webhook by its webhook UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | Webhook UUID to delete. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Block **Slug:** `PIVOT_GET_BLOCK` Return a block by ID, optionally including all visible descendant blocks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `block_id` | string | Yes | Block UUID to retrieve. | | `include_descendants` | boolean | No | Whether to include all visible descendant blocks in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Room **Slug:** `PIVOT_GET_ROOM` Return a Pivot room by its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `room_id` | string | Yes | Room UUID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Room Message **Slug:** `PIVOT_GET_ROOM_MESSAGE` Retrieve 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `room_id` | string | Yes | Room UUID containing the message. | | `sent_at` | string | Yes | Message send timestamp required to locate every message. | | `message_id` | string | Yes | Message UUID to retrieve. | | `parent_recording_id` | string | No | Recording UUID required when the message is a recording comment. | | `thread_root_message_id` | string | No | Root message UUID for a threaded reply. Provide it together with thread_parent_message_id. | | `thread_parent_message_id` | string | No | Immediate parent message UUID for a threaded reply. Provide it together with thread_root_message_id. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Room Recording **Slug:** `PIVOT_GET_ROOM_RECORDING` Return a specific Pivot room recording by ID, including transcript, chapter, summary, and caption assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `room_id` | string | Yes | Room UUID containing the recording. | | `created_at` | string | Yes | Recording creation timestamp required to locate the recording. | | `recording_id` | string | Yes | Recording UUID within the room. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Space **Slug:** `PIVOT_GET_SPACE` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID to retrieve. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Space Operation **Slug:** `PIVOT_GET_SPACE_OPERATION` Get 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | 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. | | `operation_id` | string | Yes | Asynchronous operation UUID returned by Copy Space or Create Space. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Context **Slug:** `PIVOT_GET_USER_CONTEXT` Return a Pivot user's profile, space memberships, and groups within an organization. The response excludes the provider's presence token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | User identifier accepted by Pivot, such as a user UUID. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Hide Space **Slug:** `PIVOT_HIDE_SPACE` Hide an existing Pivot space from view. The Pivot API exposes no undo path for hiding a space. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID to hide from view. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Invite To Room **Slug:** `PIVOT_INVITE_TO_ROOM` Invite people to a Pivot room by email. A successful call creates room invitations and sends externally visible invitation emails to every address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invite` | object | Yes | Invitation details. Pivot emails every recipient and creates a room invitation with the selected role. | | `room_id` | string | Yes | Room UUID to which the recipients will be invited. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Invite To Space **Slug:** `PIVOT_INVITE_TO_SPACE` Invite 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invites` | array | Yes | Invitation details, one entry per email recipient. | | `space_id` | string | Yes | Space UUID to which the recipients will be invited or added. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Block Responses **Slug:** `PIVOT_LIST_BLOCK_RESPONSES` Return the responses attached to a Pivot block. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `block_id` | string | Yes | Block UUID whose responses to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Block Sharing Rules **Slug:** `PIVOT_LIST_BLOCK_SHARING_RULES` Return the sharing rules configured for a Pivot block. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `block_id` | string | Yes | Block UUID whose sharing rules should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Group Members **Slug:** `PIVOT_LIST_GROUP_MEMBERS` Return the users in a specified Pivot group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | Group UUID whose members to return. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Groups **Slug:** `PIVOT_LIST_GROUPS` Return one page of groups in a Pivot organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of groups to return in this page. | | `next_cursor` | string | No | Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Labels **Slug:** `PIVOT_LIST_LABELS` Return the labels configured in a Pivot organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Organization Users **Slug:** `PIVOT_LIST_ORGANIZATION_USERS` Return one page of users in a Pivot organization. Pass next_cursor from the preceding response unchanged to continue listing users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of users to return in this page. | | `next_cursor` | string | No | Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Room Messages **Slug:** `PIVOT_LIST_ROOM_MESSAGES` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of messages to return in this page. | | `room_id` | string | No | Room UUID whose messages should be returned. | | `next_cursor` | string | No | 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. | | `room_created_at` | string | No | Room creation timestamp returned by Get Room. Required on the first call so pagination can stop at the oldest possible history window. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Room Recordings **Slug:** `PIVOT_LIST_ROOM_RECORDINGS` Return one page of recordings for a Pivot room, including transcripts and other recording assets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of recordings to return in this page. | | `room_id` | string | Yes | Room UUID whose recordings should be returned. | | `next_cursor` | string | No | Opaque continuation token returned by a previous call. Omit for the first page and pass it back unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Assignment Blocks **Slug:** `PIVOT_LIST_SPACE_ASSIGNMENT_BLOCKS` Return all assignment blocks in a Pivot space. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID whose assignment blocks to return. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Description Blocks **Slug:** `PIVOT_LIST_SPACE_DESCRIPTION_BLOCKS` Return a space's description blocks and all of their descendants. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID whose description blocks should be returned. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Home Blocks **Slug:** `PIVOT_LIST_SPACE_HOME_BLOCKS` Return the blocks displayed on a Pivot space home. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID whose home blocks should be returned. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Members **Slug:** `PIVOT_LIST_SPACE_MEMBERS` Return one page of members in a Pivot space. By default, only active members are returned; use status to include other membership states. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of members to return in this page. | | `status` | array | No | Membership statuses to include. Repeat the status query parameter for multiple states. Omit to return active members only. | | `space_id` | string | Yes | Space UUID whose members should be returned. | | `next_cursor` | string | No | Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Roles **Slug:** `PIVOT_LIST_SPACE_ROLES` Return the roles available in a Pivot space. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID whose available roles should be returned. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Space Room Blocks **Slug:** `PIVOT_LIST_SPACE_ROOM_BLOCKS` Return all room blocks and their parallel room metadata in a Pivot space. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID whose room blocks should be returned. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Spaces **Slug:** `PIVOT_LIST_SPACES` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of spaces to return in this page. | | `status` | string ("active" | "archived" | "deleted" | "hidden") | No | Lifecycle status to include: active, archived, deleted, or hidden. Omit to return active spaces only. | | `sort_by` | string ("created_at_asc" | "created_at_desc" | "last_activity_asc" | "last_activity_desc") | No | Order spaces by creation time or last activity, ascending or descending. | | `label_ids` | array | No | Label UUIDs used to filter spaces. | | `next_cursor` | string | No | Opaque next_cursor returned by a previous call. Omit for the first page and pass it back unchanged. | | `space_types` | array | No | Space types to include. | | `search_query` | string | No | Case-insensitive text to match against space names. | | `template_types` | array | No | Template types to include. Templates are excluded by default; include organization or global to list templates. | | `organization_id` | string | Yes | 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. | | `exclude_label_ids` | boolean | No | When true, exclude spaces carrying any label_ids; when false, include spaces matching label_ids. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Thread Messages **Slug:** `PIVOT_LIST_THREAD_MESSAGES` Return one page of messages in a Pivot thread, oldest first. Continue with next_cursor until has_more is false. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of thread messages to return in this page. | | `room_id` | string | Yes | Room UUID containing the message thread. | | `parent_id` | string | Yes | Parent message UUID identifying the thread. | | `next_cursor` | string | No | Opaque continuation token returned by a previous call. Omit it for the first page and pass it back unchanged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhook Logs **Slug:** `PIVOT_LIST_WEBHOOK_LOGS` Return one page of delivery logs for a Pivot webhook. Pivot retains webhook logs for 30 days. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of webhook delivery logs to return in this page. | | `webhook_id` | string | Yes | Webhook UUID whose delivery logs should be returned. | | `next_cursor` | string | No | Opaque next_before_time value returned by a previous response. Omit for the first page and pass it back as next_cursor unchanged. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhooks **Slug:** `PIVOT_LIST_WEBHOOKS` Return webhooks for a Pivot organization, optionally filtering by a case-insensitive substring of the webhook name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional case-insensitive substring match on webhook name. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Group Members **Slug:** `PIVOT_REMOVE_GROUP_MEMBERS` Remove one or more users from a Pivot group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | Group UUID from which to remove members. | | `user_ids` | array | No | User UUIDs to remove from the group. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Space Label **Slug:** `PIVOT_REMOVE_SPACE_LABEL` Remove one label from a Pivot space by space and label UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label_id` | string | Yes | Label UUID to remove from the space. | | `space_id` | string | Yes | Space UUID from which to remove the label. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Space Member **Slug:** `PIVOT_REMOVE_SPACE_MEMBER` Remove a user from a Pivot space by space-member UUID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `space_id` | string | Yes | Space UUID containing the member to remove. | | `member_id` | string | Yes | Space-member UUID to remove, not the underlying user UUID. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request Recording Download **Slug:** `PIVOT_REQUEST_RECORDING_DOWNLOAD` Ensure 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `room_id` | string | Yes | Room UUID containing the recording. | | `created_at` | string | Yes | Recording creation timestamp required to locate the recording. | | `recording_id` | string | Yes | Recording UUID within the room. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke Organization Invite **Slug:** `PIVOT_REVOKE_ORGANIZATION_INVITE` Revoke a Pivot organization invitation by its invitation ID and email address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Email address identifying the invitation. | | `invite_id` | string | Yes | Invitation UUID to revoke. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke Room Invite **Slug:** `PIVOT_REVOKE_ROOM_INVITE` Revoke a Pivot room invitation by room ID and email address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Email address identifying the room invitation to revoke. | | `room_id` | string | Yes | Room UUID whose invitation will be revoked. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Revoke Space Invite **Slug:** `PIVOT_REVOKE_SPACE_INVITE` Revoke a Pivot space invitation by organization, space, and email address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Email address identifying the space invitation to revoke. | | `space_id` | string | Yes | Space UUID whose invitation will be revoked. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Rotate Webhook Secret **Slug:** `PIVOT_ROTATE_WEBHOOK_SECRET` Rotate 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Room Message **Slug:** `PIVOT_SEND_ROOM_MESSAGE` Send 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | No | Plain text to send. Use this for ordinary messages; provide exactly one of text or rich_content. | | `type` | string ("MESSAGE_TYPE_AUDIO_CALL" | "MESSAGE_TYPE_UNSPECIFIED" | "MESSAGE_TYPE_VIDEO_CALL") | No | Message type, including audio or video call messages. | | `room_id` | string | Yes | Room UUID to which the message will be sent. | | `file_ids` | array | No | Pivot file UUIDs to attach to the message. | | `rich_content` | object | No | Advanced Pivot Lexical document for formatting, links, or mentions. Provide exactly one of rich_content or text. | | `parent_recording_id` | string | No | Recording UUID when the message is a recording comment. | | `thread_root_sent_at` | string | No | Send timestamp of the thread's root message. Include it when replying to a thread and the root message's sent_at is unavailable. | | `inline_reply_sent_at` | string | No | Send timestamp of the message being replied to inline. | | `thread_root_message_id` | string | No | Root message UUID for a message in a thread. | | `inline_reply_message_id` | string | No | Message UUID being replied to inline. | | `thread_parent_message_id` | string | No | Immediate parent message UUID for a threaded reply. | | `inline_reply_thread_root_message_id` | string | No | Thread-root message UUID for an inline reply inside a thread. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Block Response **Slug:** `PIVOT_SUBMIT_BLOCK_RESPONSE` Irreversibly submit a Pivot block response. This sends or marks an existing draft response as submitted and cannot be safely undone. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response_id` | string | Yes | Block response UUID to submit irreversibly. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Block **Slug:** `PIVOT_UPDATE_BLOCK` Update exactly one property of a Pivot block: its hide time, unhide time, or space-member sharing level. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `block_id` | string | Yes | Block UUID to update. | | `hide_after` | string | No | Timestamp after which the block becomes hidden. Use the current time to hide it immediately. | | `unhide_after` | string | No | Timestamp after which the block becomes visible again. Use the current time to show it immediately. | | `space_member_sharing_level` | 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") | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Block Response **Slug:** `PIVOT_UPDATE_BLOCK_RESPONSE` Replace a Pivot block response with plain text, or use advanced rich content for formatting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | No | Plain replacement text. Use this for the common unformatted-text path. | | `response_id` | string | Yes | Block response UUID to update. | | `rich_content` | object | No | Advanced Pivot Lexical document for formatted replacement content. Use either this or text, not both. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Block Sharing Rule **Slug:** `PIVOT_UPDATE_BLOCK_SHARING_RULE` Set 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `rule` | 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") | Yes | Access level to apply to the sharing subject. | | `subject` | object | Yes | Provider-defined sharing subject. Set any documented user, group, space role, membership tier, or space identifiers that apply. | | `block_id` | string | Yes | Block UUID whose sharing rule will be updated. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Label **Slug:** `PIVOT_UPDATE_LABEL` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New label name. When changing only the name, also resend the label's current color because Pivot clears an omitted color. | | `color` | string | No | New label color in #RRGGBB format. | | `label_id` | string | Yes | Label UUID to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Room **Slug:** `PIVOT_UPDATE_ROOM` Update one or more settings for a Pivot room, including its name, topic, type, and recording preferences. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New room name. | | `topic` | string | No | New room topic shown to participants. | | `room_id` | string | Yes | Room UUID to update. | | `room_type` | string ("ROOM_TYPE_UNSPECIFIED" | "ROOM_TYPE_DIRECT" | "ROOM_TYPE_CHAT" | "ROOM_TYPE_POST" | "ROOM_TYPE_AUDIO" | "ROOM_TYPE_VIDEO" | "ROOM_TYPE_STREAMING") | No | New Pivot room type. | | `record_automatically` | boolean | No | Whether the room starts recording automatically. | | `allow_recording_download` | boolean | No | Whether room members may download recordings. | | `hide_recording_by_default` | boolean | No | Whether new recordings are hidden from room members by default. | | `hide_recording_transcript` | boolean | No | Whether recording transcripts are hidden from room members. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Room Message **Slug:** `PIVOT_UPDATE_ROOM_MESSAGE` Replace 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | No | Plain replacement text. Use this for ordinary messages; provide exactly one of text or rich_content. | | `room_id` | string | Yes | Room UUID containing the message. | | `sent_at` | string | Yes | Original message send timestamp required to locate the message. | | `file_ids` | array | No | Pivot file UUIDs to retain or attach to the edited message. | | `message_id` | string | Yes | Message UUID to edit. | | `rich_content` | object | No | Advanced replacement Pivot Lexical document for formatting, links, or mentions. Provide exactly one of rich_content or text. | | `parent_recording_id` | string | No | Recording UUID required when editing a recording comment. | | `thread_root_message_id` | string | No | Root message UUID required when editing a message in a thread. | | `thread_parent_message_id` | string | No | Immediate parent message UUID when editing a threaded reply. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Space **Slug:** `PIVOT_UPDATE_SPACE` Update one or more settings or metadata fields for an existing Pivot space. Only provided fields are changed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New human-readable name for the space. | | `tags` | array | No | Complete list of tags to set on the space. | | `type` | 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") | No | New Pivot space type. | | `space_id` | string | Yes | Space UUID to update. | | `icon_name` | string | No | Pivot icon name displayed for the space. | | `link_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Link-sharing policy for the space. | | `public_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Public-sharing policy for the space. | | `organization_id` | string | Yes | 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. | | `other_type_name` | string | No | Custom type label used when type is SPACE_TYPE_OTHER. | | `cover_photo_x_offset` | integer | No | Horizontal cover-photo focal offset. | | `cover_photo_y_offset` | integer | No | Vertical cover-photo focal offset. | | `organization_sharing` | string ("SPACE_SHARING_LEVEL_DISABLED" | "SPACE_SHARING_LEVEL_JOIN" | "SPACE_SHARING_LEVEL_REQUEST" | "SPACE_SHARING_LEVEL_UNSPECIFIED") | No | Organization-wide sharing policy for the space. | | `default_space_role_id` | string | No | Role UUID assigned by default to new space members. | | `enable_progress_tracking` | boolean | No | Whether progress tracking is enabled for the space. | | `allow_block_sharing_users` | boolean | No | Whether blocks may be shared directly with individual users. | | `allow_block_sharing_public` | boolean | No | Whether blocks may be shared publicly. | | `allow_block_sharing_organization_members` | boolean | No | Whether blocks may be shared with other organization members. | | `only_allow_existing_organization_members` | boolean | No | Whether invitations are limited to people who are already organization members. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Space Member **Slug:** `PIVOT_UPDATE_SPACE_MEMBER` Update 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | New plain-text title for the member in the space. | | `status` | 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") | No | New membership status for the space member. | | `role_ids` | array | No | Complete list of space-role UUIDs to grant to the member. | | `space_id` | string | Yes | Space UUID containing the member. | | `member_id` | string | Yes | Space-member UUID to update, not the underlying user UUID. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Webhook **Slug:** `PIVOT_UPDATE_WEBHOOK` Update one or more properties of a Pivot webhook. Supplying subscriptions replaces the webhook's complete existing subscription set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | New human-readable name for the webhook. | | `status` | string ("WEBHOOK_STATUS_UNSPECIFIED" | "WEBHOOK_STATUS_ACTIVE" | "WEBHOOK_STATUS_INACTIVE" | "WEBHOOK_STATUS_PAUSED") | No | New lifecycle status for the webhook. | | `webhook_id` | string | Yes | Webhook UUID to update. | | `description` | string | No | New human-readable description for the webhook. | | `endpoint_url` | string | No | New public HTTPS callback URL that receives webhook deliveries. | | `subscriptions` | array | No | Complete replacement subscription set. When supplied, Pivot replaces all existing subscriptions; at least one subscription is required. | | `organization_id` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |