Podio
Project management and collaboration platform by Citrix.
Authentication
This connector uses OAuth 2.0 authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 420 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_action_by_action_id | Returns the action with the given id | action_id (string) required |
| get_app_store_category | Returns the categories available in the system. | only_used (string) |
| get_app_store_org | Returns all the orgs, that the user is member of, and that has shared private apps. | No parameters |
| get_app_store_by_type_own | Returns all the apps that the active user has shared. | type (string) required limit (string) offset (string) |
| get_app_store_by_type_recommended_by_area | Returns the recommended apps in the app market for the given 'area'. Current areas are: 'web' and 'mobile'. | type (string) required area (string) required |
| get_app_store_by_share_id_v2 | Returns the shared app from the app market with the given id. It will also return all comments and fivestar ratings of the app. | share_id (string) required |
| get_app_store_by_ref_type_by_ref_id | Returns the shares of the given object. The active users shares will be first followed by other users shares. Besides that the shares will be sorted descending by when they were shared. | ref_type (string) required ref_id (string) required |
| get_app_store_by_type_author_by_user_id | Returns all the apps in the app market created by the given user in the given language. | type (string) required user_id (string) required limit (string) offset (string) sort (string) |
| get_app_store_by_type_category_by_category_id | Returns the apps in the app market in the given category and language. | type (string) required category_id (string) required limit (string) offset (string) sort (string) |
| get_app_store_by_type_top | Returns the top apps in the app market in the given language. | type (string) required limit (string) offset (string) |
| post_app_store_by_share_id_install | Installs the share with the given id on the space. | share_id (string) required data: { . space_id (string) . dependencies (string) } (object) required |
| post_app_store | Shares the app or pack in the app market. | data: { . scope (string) . ref_type (string) . ref_id (string) . name (string) . abstract (string) . description (string) . language (string) . category_ids (string) . file_ids (string) . video (string) . features (string) . children (string) } (object) required |
| delete_app_store_by_share_id | Unshares the given app from the app market | share_id (string) required |
| put_app_store_by_share_id | Updates the share with changes to abstract, description, etc. | share_id (string) required data: { . name (string) . abstract (string) . description (string) . language (string) . category_ids (string) . file_ids (string) } (object) required |
| post_app_by_app_id_activate | Activates a deactivated app. This puts the app back in the app navigator and allows insertion of new items. | app_id (string) required |
| post_app | Creates a new app on a space. | data: { . silent (string) } (object) required |
| get_app | Returns all the apps for the active user. | exclude_app_ids (string) exclude_demo (string) limit (string) order (string) referenceable_in_org (string) right (string) target_space_id (string) text (string) |
| post_app_by_app_id_field | Adds a new field to an app | app_id (string) required data: { . type (string) . description (string) . delta (string) } (object) required |
| post_app_by_app_id_deactivate | Deactivates the app with the given id. This removes the app from the app navigator, and disables insertion of new items. | app_id (string) required |
| delete_app_by_app_id | Deletes the app with the given id. This will delete all items, widgets, filters and shares on the app. This operation is not reversible. | app_id (string) required silent (string) |
| get_app_by_app_id | Gets the definition of an app and can include configuration and fields. This method will always return the latest revision of the app definition. | app_id (string) required |
| put_app_by_app_id | Updates an app. The update can contain an new configuration for the app, addition of new fields as well as updates to the configuration of existing fields. Fields not included will not be deleted. To delete a field use the 'delete field' operation. | app_id (string) required data: { . silent (string) } (object) required |
| delete_app_by_app_id_field_by_field_id | Deletes a field on an app. When deleting a field any new items and updates to existing items will not have this field present. For existing items, the field will still be presented when viewing the item. | app_id (string) required field_id (string) required delete_values (string) |
| put_app_by_app_id_field_by_field_id | Updates the configuration of an app field. The type of the field cannot be updated, only the configuration. | app_id (string) required field_id (string) required data: { . label (string) . description (string) . delta (string) . mapping (string) } (object) required |
| get_app_org_by_org_label_space_by_space_label_by_app_label | Returns app based on the provided org_label, space_label and app_label. | org_label (string) required space_label (string) required app_label (string) required |
| get_app_by_app_id_dependencies | Returns the apps that the given app depends on. | app_id (string) required |
| get_app_by_app_id_field_by_field_or_external_id | Returns a single field from an app. | app_id (string) required field_or_external_id (string) required |
| get_app_by_app_id_inverse_dependencies | Returns the apps that depend on the given app_id. | app_id (string) required |
| get_app_space_by_space_id_by_url_label | Returns the app on the given space with the given URL label | space_id (string) required url_label (string) required |
| get_app_space_by_space_id | Returns all the apps on the space that are visible. The apps are sorted by any custom ordering and else by name. | space_id (string) required include_inactive (string) |
| get_app_features | Returns the features that the given apps and optionally space includes. The current list of features are: | app_ids (string) include_space (string) |
| get_app_icon_search | Any search term to match. | query (string) |
| get_space_by_space_id_dependencies | Returns all the active apps on the space along with their dependencies. The dependencies are only one level deep. | space_id (string) required |
| get_app_top | Returns the top apps for the active user. This is the apps that the user have interacted with the most. | exclude_demo (string) limit (string) |
| get_app_org_by_org_id_top | Returns the top apps for the user inside the given organization | org_id (string) required |
| post_app_by_app_id_install | Installs the app with the given id on the space. | app_id (string) required data: { . features (string) } (object) required |
| put_app_by_app_id_description | Updates the app with a new description | app_id (string) required data: { . silent (string) } (object) required |
| put_app_space_by_space_id_order | Updates the order of the apps on the space. It should post all the apps from the space in the order required. | space_id (string) required |
| put_app_by_app_id_usage | Updates the usage instructions for the app | app_id (string) required data: { . silent (string) } (object) required |
| put_app_by_app_id_v2 | Updates an app. The update can contain an new configuration for the app, addition of new fields as well as updates to the configuration of existing fields. Fields not included will not be deleted. To delete a field use the 'delete field' operation. | app_id (string) required data: { . silent (string) } (object) required |
| get_batch_by_batch_id | Returns the batch with the given id | batch_id (string) required |
| get_batch | Returns the batches created by the user. The batches are sorted descending by date of creation. | No parameters |
| get_batch_by_ref_type_by_ref_id_by_plugin_running | Returns the currently running batches on the given reference. The reference can either be a space or an app. The plugin can either be 'app_import', 'app_export', 'space_contact_import' or 'app_content'. | ref_type (string) required ref_id (string) required plugin (string) required |
| post_calendar_app_by_app_id_filter | Returns the calendar for the given app filtered using the item filters. | app_id (string) required |
| get_calendar_app_by_app_id | Returns the items and tasks that are related to the given app. | app_id (string) required date_from (string) date_to (string) priority (string) tasks (string) |
| get_calendar_app_by_app_id_ics_by_user_id_by_token | Returns the app calendar in the iCal format 90 days into the future. The token in the URI refers to the user'scalendar_codeand can be retrieved by getting the user status. | app_id (string) required user_id (string) required token (string) required tasks (string) |
| get_calendar_summary | Returns the calendar summary for the active user | limit (string) priority (string) |
| get_calendar_personal_summary | Returns the calendar summary for personal tasks and personal spaces and sub-orgs. | limit (string) priority (string) |
| get_calendar_space_by_space_id_summary | Returns the calendar summary for the given space for the active user | space_id (string) required limit (string) priority (string) |
| get_calendar_export_linked_account_by_linked_account_id_by_ref_type_by_ref_id | Returns the current export for the current linked account and ref | linked_account_id (string) required ref_type (string) required ref_id (string) required |
| get_calendar_export_by_ref_type_by_ref_id | Returns the calendar exports for the given reference. Valid reference types are 'app' and 'space'. | ref_type (string) required ref_id (string) required |
| get_calendar | Returns all items that the user have access to and all tasks that are assigned to the user. The items and tasks can be filtered by a list of space ids, but tasks without a reference will always be returned. | date_from (string) date_to (string) priority (string) tasks (string) |
| get_calendar_ics_by_user_id_by_token | Returns the user's global calendar in the iCal format 90 days into the future. The token in the URI refers to the user'scalendar_codeand can be retrieved by getting the user status. | user_id (string) required token (string) required tasks (string) |
| get_calendar_export_linked_account_by_linked_account_id | You can simulate the API request by filling out the arguments below, and press the submit button to see the response. | linked_account_id (string) required |
| get_calendar_export | Returns the exports configured for the global calendar | No parameters |
| get_calendar_item_by_item_id_field_by_field_id_ics | Returns the calendar for the given date field of the given item in the iCal format. | item_id (string) required field_id (string) required |
| get_calendar_linked_account_by_linked_account_id | Returns the events in the primary calendar of the linked account in the given interval | linked_account_id (string) required date_from (string) date_to (string) |
| get_calendar_space_by_space_id | Returns all items and tasks that the user have access to in the given space. Tasks with reference to other spaces are not returned or tasks with no reference. | space_id (string) required date_from (string) date_to (string) priority (string) tasks (string) |
| get_calendar_space_by_space_id_ics_by_user_id_by_token | Returns the space calendar in the iCal format 90 days into the future. The token in the URI refers to the user'scalendar_codeand can be retrieved by getting the user status. | space_id (string) required user_id (string) required token (string) required tasks (string) |
| get_calendar_task_by_task_id_ics | Returns the calendar for the given task in the iCal format. | task_id (string) required |
| post_calendar_linked_account_by_linked_account_id_event_by_uid_move | Move event in external calendar linked by linked_account | linked_account_id (string) required uid (string) required data: { . day_delta (string) } (object) required |
| put_calendar_event_by_uid | Update the calendar event with the given UID with a new start and end time. All dates and times should be given in the users local timezone. | uid (string) required |
| put_calendar_linked_account_by_linked_account_id_event_by_uid_duration | Change duration of external event | linked_account_id (string) required uid (string) required data: { . day_delta (string) } (object) required |
| post_comment_by_type_by_id | Adds a new comment to the object of the given type and id, f.ex. item 1. | type (string) required id (string) required data: { . alert_invite (string) . hook (string) . silent (string) } (object) required |
| get_comment_by_type_by_id | Used to retrieve the comments that have been made on an object of the given type and with the given id. It returns a list of the comments sorted in ascending order by time created. | type (string) required id (string) required limit (string) offset (string) |
| delete_comment_by_comment_id | Deletes a comment made by a user. This can be used to retract a comment that was made and which the user regrets. | comment_id (string) required hook (string) |
| get_comment_by_comment_id | Returns the contents of a comment. It is not possible to see where the comment was made, only the comment itself. | comment_id (string) required |
| put_comment_by_comment_id | Updates an already created comment. This should only be used to correct spelling and grammatical mistakes in the comment. | comment_id (string) required data: { . external_id (string) . file_ids (string) . embed_id (string) . embed_url (string) } (object) required |
| get_comment_by_comment_id_revision | Returns all the revisions on the given comment, including the current revision. Revisions are returned with the oldest first. | comment_id (string) required |
| post_contact_space_by_space_id | Creates a new space contact for use by everyone on the space. | space_id (string) required data: { . external_id (string) } (object) required |
| get_contact_space_by_space_id | Returns all the profiles of the users contacts on the given space. For the details of the possible return values, see the area. | space_id (string) required field (string) contact_type (string) exclude_self (string) limit (string) offset (string) order (string) required (string) type (string) |
| delete_contact_by_profile_ids | Deletes the contacts with the given ids. It is currently only allowed to delete contacts of type 'space'. | profile_ids (string) required |
| get_contact_totals | Returns the total number of contacts for the active user. | exclude_self (string) |
| get_contact_totals_v3 | Returns the total number of contacts for the active user. | No parameters |
| get_contact_by_profile_ids_v2 | Returns all the contact details about the contacts with the given profile ids. | profile_ids (string) required space_id (string) |
| get_contact | Used to get a list of contacts for the user. | field (string) contact_type (string) exclude_self (string) external_id (string) limit (string) offset (string) order (string) required (string) type (string) |
| post_contact_linked_account_by_linked_account_id | Loads the contact from the given linked account with the given external id. The linked account must support the 'contacts' capability. | linked_account_id (string) required data: { . external_contact_id (string) } (object) required |
| get_contact_linked_account_by_linked_account_id | Loads the contacts from the given linked account. The linked account must support the 'contacts' capability. | linked_account_id (string) required contactable (string) limit (string) name (string) offset (string) |
| get_contact_org_by_org_id | Returns all the profiles of the users contacts on the given organization. For the details of the possible return values, see the area. | org_id (string) required field (string) contact_type (string) exclude_self (string) limit (string) offset (string) order (string) required (string) type (string) |
| get_contact_skill | Returns the skills of related contacts, ordered by most frequently used. | limit (string) text (string) |
| get_contact_space_by_space_id_totals_space | Returns the total number of contacts on the space | space_id (string) required |
| get_contact_app_by_app_id | Returns all the space contacts referenced by the given app. | app_id (string) required field (string) limit (string) offset (string) order (string) |
| get_contact_user_by_user_id | Returns the contact with the given user id. | user_id (string) required |
| get_contact_user_by_user_id_by_key | Returns the value of a contact with the specific field. For the possible keys to use, see the area. | user_id (string) required key (string) required |
| get_contact_by_profile_id_vcard | Returns the vCard for the given contact. | profile_id (string) required |
| put_contact_by_profile_id | Updates the contact with the given profile id. It is currently only possible to update contacts of type 'space'. | profile_id (string) required |
| put_contact_by_profile_id_by_key | Updates the given field on the given contact. Updates are currently only allowed from contacts of type 'space'. | profile_id (string) required key (string) required data: { . value (string) } (object) required |
| post_conversation_by_conversation_id_participant | Adds new participants to the conversation. | conversation_id (string) required data: { . participants (string) } (object) required |
| post_conversation_by_conversation_id_participant_v2 | Adds new participants to the conversation. | conversation_id (string) required data: { . participants (string) } (object) required |
| post_conversation | Creates a new conversation with a list of users. Once a conversation is started, the participants cannot yet be changed. | data: { . subject (string) . text (string) . file_ids (string) . participants (string) . embed_id (array) . embed_url (string) . session (string) . type (string) . data (string) } (object) required |
| get_conversation | Returns all the users conversations ordered by time of the last event. | limit (string) offset (string) |
| post_conversation_by_ref_type_by_ref_id | Creates a new conversation on the given object. Works similarly to the create notification method in other regards. | ref_type (string) required ref_id (string) required |
| get_conversation_by_ref_type_by_ref_id | Returns a list of all the conversations on the object that the active user is part of. | ref_type (string) required ref_id (string) required |
| post_conversation_v2 | Creates a new conversation with a list of users. Once a conversation is started, the participants cannot yet be changed. | data: { . subject (string) . text (string) . file_ids (string) . participants (string) . embed_id (array) . session (string) . type (string) . data (string) } (object) required |
| get_conversation_by_conversation_id | Gets the conversation including participants with the the given id. Only participants in the conversation is allowed to view the conversation. | conversation_id (string) required |
| get_conversation_event_by_event_id | Returns data about the given event. | event_id (string) required |
| get_conversation_by_conversation_id_event | Returns the events on the conversation. | conversation_id (string) required limit (string) offset (string) |
| get_conversation_direct_by_user_id | Returns the existing direct conversation with the user. If none exists a 404 will be returned. | user_id (string) required |
| get_conversation_by_flag_count | Returns the number of conversations with the given flag. The flag can be one of: | flag (string) required |
| get_conversation_by_flag | Returns the conversations with the given flag. The flag can be one of: | flag (string) required limit (string) offset (string) |
| post_conversation_by_conversation_id_leave | Leave the given conversation. | conversation_id (string) required |
| post_conversation_read | Marks all the users conversations as read. | No parameters |
| post_conversation_by_conversation_id_read | Mark the conversation as read. | conversation_id (string) required |
| delete_conversation_by_conversation_id_read | Mark the conversation as unread | conversation_id (string) required |
| post_conversation_by_conversation_id_reply | Creates a reply to the conversation. | conversation_id (string) required data: { . text (string) . embed_id (array) . embed_url (string) } (object) required |
| post_conversation_by_conversation_id_reply_v2 | Creates a reply to the conversation. Returns the conversation event this generates. | conversation_id (string) required |
| get_conversation_search | Returns the users conversations that match the given text ordered by time of the last event. | limit (string) offset (string) |
| post_conversation_by_conversation_id_star | Star the given conversation. If the conversation is already starred, nothing will happen. | conversation_id (string) required |
| delete_conversation_by_conversation_id_star | Removes the star from the conversation. | conversation_id (string) required |
| post_mobile_install_app_by_app_id | Pushes the app to the active users mobile phones. | app_id (string) required |
| post_email_contact_by_name_by_ref_type_by_ref_id_export | Exports the email contact for the given reference and name to the linked account given in the body. Valid combinations of name and ref_type is: | name (string) required ref_type (string) required ref_id (string) required data: { . linked_account_id (string) } (object) required |
| post_email_contact_by_name_export | Exports the email contact for the given name to the linked account given in the body. Valid names are: | name (string) required data: { . linked_account_id (string) } (object) required |
| get_email_app_by_app_id | Returns the current email configuration for the given app | app_id (string) required |
| put_email_app_by_app_id | Updates the app email configuration | app_id (string) required data: { . attachments (string) . mappings (string) } (object) required |
| get_email_contact_by_name_by_ref_type_by_ref_id | Return the email contact for the given reference and name. Valid combinations of name and ref_type is: | name (string) required ref_type (string) required ref_id (string) required |
| get_email_contact_by_name_by_ref_type_by_ref_id_vcard | Return the email contact for the given reference and name. Valid combinations of name and ref_type is: | name (string) required ref_type (string) required ref_id (string) required |
| get_email_contact_by_name | Returns the email contact for the given name. Valid names are: | name (string) required |
| get_email_contact_by_name_vcard | Returns the email contact as a vcard for the given name. Valid names are: | name (string) required |
| get_email_group | Returns the subscription status for all the email groups. | No parameters |
| put_email_group | Updates the email groups the user is subscribed to. | data: { . digest (string) . bulletin (string) } (object) required |
| post_embed | Grabs metadata and returns metadata for the given url such as title, description and thumbnails. | data: { . url (string) } (object) required |
| post_file_by_file_id_attach | Attaches the uploaded file to the given object. Valid objects are 'status', 'item', 'comment', 'space', or 'task'. | file_id (string) required data: { . silent (string) } (object) required |
| post_file_by_file_id_copy | Copies the file, which makes it available for attaching to another object. | file_id (string) required |
| delete_file_by_file_id | Deletes the file with the given id. | file_id (string) required |
| get_file_by_file_id | Returns the file with the given id | file_id (string) required |
| put_file_by_file_id | Used to update the description of the file. | file_id (string) required data: { . description (string) } (object) required |
| get_file | Returns a list of all files matching the given filters and sorted by the specified attribute. | attached_to (string) created_by (string) created_on (string) filetype (string) hosted_by (string) limit (string) sort_by (string) sort_desc (string) |
| post_file | Uploads a new file. After upload the file can either be attached directly to a file using the attach operation, used to replace an existing file using the replace operation or used as file id when posting a new object. We use multipart/form-data for the request format, since most uploaded files are binary. | No parameters |
| get_file_app_by_app_id | Returns all the files related to the items in the application. This includes files both on the item itself and in comments on the item. | app_id (string) required attached_to (string) created_by (string) created_on (string) filetype (string) hosted_by (string) limit (string) offset (string) sort_by (string) sort_desc (string) |
| get_file_space_by_space_id | Returns all the files on the space order by the file name. | space_id (string) required attached_to (string) created_by (string) created_on (string) filetype (string) hosted_by (string) limit (string) offset (string) sort_by (string) sort_desc (string) |
| get_file_space_by_space_id_latest | Returns the latest files on the space order descending by the date the file was uploaded. | space_id (string) required limit (string) offset (string) |
| get_file_linked_account_by_linked_account_id | Returns a list of all linked account files and folders associated with the given linked_account_id. | linked_account_id (string) required external_folder_id (string) filetype (string) limit (string) name (string) sort_by (string) sort_desc (string) |
| post_file_linked_account_by_linked_account_id | Uploads a linked account file for the given linked_account_id. After upload the file can either be attached directly to a file using the attach operation, used to replace an existing file using the replace operation or used as file id when posting a new object. | linked_account_id (string) required data: { . external_file_id (string) } (object) required |
| post_file_by_file_id_replace | Marks the current file as an replacement for the old file. Only files with type of 'attachment' can be replaced. | file_id (string) required data: { . old_file_id (string) } (object) required |
| post_flow_by_ref_type_by_ref_id | Creates a new flow on the given reference. Only valid reference is 'app'. | ref_type (string) required ref_id (string) required |
| get_flow_by_ref_type_by_ref_id | Get all the flows on the given ref. | ref_type (string) required ref_id (string) required |
| delete_flow_by_flow_id | Delete the flow with the given id. | flow_id (string) required |
| get_flow_by_flow_id | Returns the flow with the given id. | flow_id (string) required |
| put_flow_by_flow_id | Updates the flow. The type cannot be changed. | flow_id (string) required data: { . config (string) } (object) required |
| post_flow_by_ref_type_by_ref_id_effect_attributes | Get's the effect attributes for the effect | ref_type (string) required ref_id (string) required |
| get_flow_by_flow_id_context | Returns the possible attributes on the given flow. | flow_id (string) required |
| post_flow_by_ref_type_by_ref_id_attributes | Get's the possible attributes to use as variables for a given effect attribute. | ref_type (string) required ref_id (string) required |
| post_form_by_form_id_activate | Enables the form with the given id. Only disabled forms can be enabled, which makes it once again possible to create items in the app using the form. | form_id (string) required |
| post_form_app_by_app_id | Creates a new form on the app. | app_id (string) required data: { . css (string) } (object) required |
| get_form_app_by_app_id | Returns all the active forms on the given app. | app_id (string) required |
| post_form_by_form_id_deactivate | Disables the form with given id. This makes it impossible to create new items using the form. Instead, a message about the form being disabled is shown. | form_id (string) required |
| delete_form_by_form_id | Deletes the form with the given id. | form_id (string) required |
| get_form_by_form_id | Returns the form with the given id. | form_id (string) required |
| put_form_by_form_id | Updates the form with new settings, domains, fields, etc. | form_id (string) required data: { . css (string) } (object) required |
| delete_friend_by_user_ids | Remove from friends the users with the given user ids. | user_ids (string) required |
| get_grant_by_ref_type_by_ref_id_count | Returns the count of grants on the given object | ref_type (string) required ref_id (string) required |
| post_grant_by_ref_type_by_ref_id | Create a grant on the given object to the given users. | ref_type (string) required ref_id (string) required data: { . people (string) . action (string) . message (string) } (object) required |
| get_grant_by_ref_type_by_ref_id | Returns the grants on the given object | ref_type (string) required ref_id (string) required |
| delete_grant_by_ref_type_by_ref_id | Removes all grants on the object with the given type and id. | ref_type (string) required ref_id (string) required |
| get_grant_space_by_space_id_user_by_user_id | Returns all the grants for the user on the given space. | space_id (string) required user_id (string) required |
| get_grant_by_ref_type_by_ref_id_own | Return the grant information for the active user, if any | ref_type (string) required ref_id (string) required |
| get_grant_org_by_org_id_own | Returns all the grants for the current user on the given organization. | org_id (string) required |
| delete_grant_by_ref_type_by_ref_id_by_user_id | Removes the grant from the given user on the given object | ref_type (string) required ref_id (string) required user_id (string) required |
| put_grant_by_ref_type_by_ref_id_by_user_id | Updates the grant with a new access level.App sharing updates are not allowed in this API. | ref_type (string) required ref_id (string) required user_id (string) required |
| post_hook_by_ref_type_by_ref_id | Create a new hook on the given object. See the area for details. | ref_type (string) required ref_id (string) required data: { . url (string) . type (string) } (object) required |
| get_hook_by_ref_type_by_ref_id | Returns the hooks on the object. | ref_type (string) required ref_id (string) required |
| delete_hook_by_hook_id | Deletes the hook with the given id. | hook_id (string) required |
| post_hook_by_hook_id_verify_request | Request the hook to be validated. This will cause the hook to send a request to the URL with the parameter 'type' set to 'hook.verify' and 'code' set to the verification code. The endpoint must then call the validate method with the code to complete the verification. | hook_id (string) required |
| post_hook_by_hook_id_verify_validate | Validates the hook using the code received from the verify call. On successful validation the hook will become active. | hook_id (string) required data: { . code (string) } (object) required |
| get_importer_by_file_id_info | Returns the import information about the given file. | file_id (string) required |
| post_importer_by_file_id_preview_by_row | Returns a preview for the given row | file_id (string) required row (string) required |
| post_importer_by_file_id_item_app_by_app_id | Imports the file into the given app. The mapping value for a field depends on the type of field: | file_id (string) required app_id (string) required data: { . app_id (string) . mappings (string) . field_id (string) . unique (string) . value (string) . tags_column_id (string) } (object) required |
| post_importer_by_file_id_contact_space_by_space_id | Imports the given file into the space contacts on the given space. | file_id (string) required space_id (string) required data: { . mappings (string) . field_key (string) . unique (string) . column_id (string) } (object) required |
| post_integration_by_app_id | Creates a new integration on the app | app_id (string) required data: { . type (string) . silent (string) . config (string) } (object) required |
| delete_integration_by_app_id | Deletes the integration from the given app. | app_id (string) required |
| get_integration_by_app_id | Returns the integration with the given id. | app_id (string) required |
| put_integration_by_app_id | Updates the configuration of the integration. The configuration depends on the type of integration. | app_id (string) required data: { . silent (string) . config (string) } (object) required |
| get_integration_by_app_id_field | Returns the fields available from the configuration. | app_id (string) required |
| put_integration_by_app_id_mapping | Updates the mapping between the fields of the app and the fields available from the integration. | app_id (string) required |
| post_item_app_by_app_id | Adds a new item to the given app. | app_id (string) required data: { . hook (string) . silent (string) } (object) required |
| post_item_app_by_app_id_delete | Deletes items from a given app based in bulk and removes them from all views. The data can no longer be retrieved. | app_id (string) required data: { . silent (string) } (object) required |
| post_item_app_by_app_id_calculate | Performs a calculation on the given app. The calculation is made up of 4 parts; aggreation, formula, grouping and filtering, and each part will be documented below. | app_id (string) required data: { . limit (string) . aggregation (string) . formula (string) . type (string) . value (string) . groupings (string) . sub_value (string) . filters (string) . key (string) . values (string) } (object) required |
| post_item_by_item_id_clone | Clones the given item creating a new item with identical values in the same app. | item_id (string) required data: { . silent (string) } (object) required |
| get_item_by_item_id_clone | Return all the values cloned for an item. The values are not saved, but can be used as values for creating a new item. | item_id (string) required |
| delete_item_by_item_id | Deletes an item and removes it from all views. The item can no longer be retrieved. | item_id (string) required hook (string) silent (string) |
| get_item_by_item_id | Returns the item with the specified id. | item_id (string) required mark_as_viewed (string) |
| put_item_by_item_id | Update an already existing item. Values will only be updated for fields included. To delete all values for a field supply an empty array as values for that field. | item_id (string) required data: { . hook (string) . silent (string) } (object) required |
| delete_item_by_item_id_ref | Removes the reference from the item if any | item_id (string) required |
| post_item_app_by_app_id_export_by_exporter | Creates a batch for exporting the items. Valid exporters are currently 'xls' and 'xlsx'. | app_id (string) required exporter (string) required data: { . limit (string) . offset (string) . view_id (string) . sort_desc (string) . filters (string) } (object) required |
| post_item_app_by_app_id_filter | Filters the items and returns the matching items. Full details of the filtering options available can be found in the 'Views' area. | app_id (string) required data: { . space_id (string) } (object) required |
| post_item_app_by_app_id_filter_by_view_id | Retrieves the items in the app based on the given view | app_id (string) required view_id (string) required data: { . limit (string) . offset (string) . remember (string) . sort_by (string) . sort_desc (string) } (object) required |
| get_item_field_by_field_id_find | Used to find possible items for a given application field. It searches the relevant apps for items matching the given text. | field_id (string) required limit (string) not_item_id (string) text (string) |
| get_item_app_by_app_id_values | Used to get the distinct values for all items in an app. Will return a list of the distinct item creators, as well as a list of the possible values for fields of type 'state', 'member', 'app', 'number', 'calculation', 'progress' and 'question'. | app_id (string) required |
| get_item_field_by_field_id_range | Returns the range for the given field. Only valid for fields of type 'number', 'calculation' and 'money'. | field_id (string) required |
| get_app_by_app_id_item_by_app_item_id | Returns the full item by its app_item_id, which is a unique ID for items per app. | app_id (string) required app_item_id (string) required |
| get_item_app_by_app_id_external_id_by_external_id | Retrieve an app item with the given external_id. | app_id (string) required external_id (string) required |
| get_item_app_by_app_id_count | Returns the number of items on app matching a given saved view or set of filters. | app_id (string) required key (string) view_id (string) |
| get_item_by_item_id_value_by_field_id | Returns the values for a specified field on an item | item_id (string) required field_id (string) required |
| get_item_by_item_id_value_by_field_or_external_id_v2 | Return the values for the given field on the given item. The field can be given either as the id of the field or the external id of the field. | item_id (string) required field_or_external_id (string) required |
| get_item_by_item_id_reference_by_field_id_preview | Returns a preview of the item for referencing on the given field. | item_id (string) required field_id (string) required |
| get_item_by_item_id_reference | Returns up to thousand items that have a reference to the given item. The references are grouped by app. Both the apps and the items are sorted by title. | item_id (string) required limit (string) |
| get_item_by_item_id_revision_by_revision | Returns the data about the specific revision on an item | item_id (string) required revision (string) required |
| delete_item_by_item_id_revision_by_revision | Reverts the change done in the given revision. This restores the changes done between the given revision and the previous revision, overwriting any changes done on the same fields after the revision. | item_id (string) required revision (string) required |
| get_item_by_item_id_revision_by_revision_from_by_revision_to | Returns the difference in fields values between the two revisions. | item_id (string) required revision_from (string) required revision_to (string) required |
| get_item_by_item_id_revision | Returns all the revisions that have been made to an item up to a maximum of the last 30 revisions. | item_id (string) required |
| get_item_by_item_id_value | Returns all the values for an item, with the additional data provided by the get item operation. | item_id (string) required |
| put_item_by_item_id_value | Updates all the values for an item | item_id (string) required data: { . hook (string) . silent (string) } (object) required |
| get_item_by_item_id_value_v2 | Returns the field values on the given item. | item_id (string) required |
| get_item_app_by_app_id_xlsx | Returns the items in the Xlsx format. | app_id (string) required key (string) deleted_columns (string) limit (string) offset (string) remember (string) sort_by (string) sort_desc (string) view_id (string) |
| get_item_by_item_id_meeting_url | Gets the URL to join the given meeting. If the user is the organizer of the meeting, the meeting will be started and the URL will log in the user automatically. | item_id (string) required |
| get_item_by_item_id_field_by_field_id_recalc_status | Returns the recalc status for the requested calculation field in the item. | item_id (string) required field_id (string) required |
| get_item_by_item_id_reference_field_by_field_id | Returns all the references to the item from the given field | item_id (string) required field_id (string) required limit (string) offset (string) |
| get_item_field_by_field_id_top | Returns the top possible values for the given field. This is currently only valid for fields of type 'app'. | field_id (string) required limit (string) not_item_id (string) |
| post_item_by_item_id_rearrange | Update the item's values | item_id (string) required data: { . values (string) } (object) required |
| post_item_by_item_id_revision_by_revision_revert_to | Reverts the item to the values in the given revision. This will undo any changes made after the given revision. | item_id (string) required revision (string) required |
| put_item_by_item_id_participation | Updates the participation status for the active user on the item | item_id (string) required data: { . status (string) } (object) required |
| put_item_by_item_id_value_by_field_or_external_id | Update the item values for a specific field. The identifier for the field can either be the field_id or the external_id for the field. | item_id (string) required field_or_external_id (string) required data: { . hook (string) . silent (string) } (object) required |
| delete_layout_by_app_id_by_badge_relationship | Delete custom badge. | app_id (string) required badge|relationship (string) required |
| get_item_by_item_id_badge_by_layout_type | Get badge view of user accessible item: | item_id (string) required layout_type (string) required |
| get_layout_by_app_id_by_badge_relationship_default | Returns the definition of a default badge layout | app_id (string) required badge|relationship (string) required |
| get_layout_by_app_id_by_badge_type | Returns the definition of badge layout | app_id (string) required badge_type (string) required |
| post_layout_by_app_id_by_layout_type | Update layout definition for an app: | app_id (string) required layout_type (string) required |
| get_linked_account | Get all linked accounts for the currently logged in user | capability (string) provider (string) |
| get_notification_inbox_new_count | Returns the number of unread notifications for the active user. | No parameters |
| get_notification_by_notification_id | Retrieves a single notification grouped similarly to the get notifications operation. | notification_id (string) required |
| get_notification_settings | Returns the notification settings for the active user | No parameters |
| put_notification_settings | Updates the notification settings for the user | data: { . digest (string) . bulletin (string) . reference (string) . message (string) . space (string) . subscription (string) } (object) required |
| get_notification | Returns a list of notifications based on the query parameters. The notifications will be grouped based on their context. | context_type (string) created_from (string) created_to (string) direction (string) limit (string) offset (string) starred (string) type (string) user_id (string) viewed (string) viewed_from (string) |
| post_notification_viewed | Marks all the users notifications as viewed. | No parameters |
| delete_notification_by_notification_id_viewed | Mark the notification as unviewed. This will move the notification from the viewed archive to the inbox. | notification_id (string) required |
| post_notification_by_notification_id_viewed | Mark the notification as viewed. This will move the notification from the inbox to the viewed archive. | notification_id (string) required |
| delete_notification_by_ref_type_by_ref_id_viewed | Marks all notifications on the given object as unviewed | ref_type (string) required ref_id (string) required |
| post_notification_by_ref_type_by_ref_id_viewed | Marks all notifications on the given object as viewed | ref_type (string) required ref_id (string) required |
| post_notification_by_notification_id_star | Star the given notification to move it to the star list. | notification_id (string) required |
| delete_notification_by_notification_id_star | Removes the star on the notification | notification_id (string) required |
| post_org | Creates a new organization. | data: { . name (string) . logo (string) } (object) required |
| get_org | Returns a list of all the organizations and spaces the user is member of. | No parameters |
| post_org_by_org_id_appstore | Creates an app store profile for the organization if it doesn't already exist. | org_id (string) required |
| delete_org_by_org_id_appstore | Deletes the organizations app store profile | org_id (string) required |
| get_org_by_org_id_appstore | Gets the appstore profile of an organization, if any. | org_id (string) required |
| put_org_by_org_id_appstore | Updates the appstore profile of the organization. | org_id (string) required |
| delete_org_by_org_id_member_by_user_id_role | Removes the role from the given user on the given organization. | org_id (string) required user_id (string) required |
| delete_org_by_org_id_member_by_user_id | Ends the users membership of all spaces in the organization. In workspaces in the organization where the user is the last admin, other users will be promoted to admins. Workspaces where the user is the only member will be deleted. | org_id (string) required user_id (string) required |
| get_org_by_org_id_member_by_user_id | Returns the member data for the given user in the given organization. | org_id (string) required user_id (string) required |
| get_org_admin_orgs_by_email | Get Orgs For which given email is an admin along with free orgs where email is part of | email (string) required |
| get_org_by_org_id_all_spaces | Returns all workspaces in an organization, when the admin viewing this information is not a member of a workspace, the name will not be returned. | org_id (string) required |
| get_org_by_org_id | Gets the organization with the given id. | org_id (string) required |
| put_org_by_org_id | Updates an organization with new name and logo. Note that the URL of the organization will not change even though the name changes. | org_id (string) required data: { . name (string) . url_label (string) . logo (string) } (object) required |
| get_org_by_org_id_admin | Returns the administrators of the organization. | org_id (string) required |
| get_org_url | Returns the organization with the given full URL. The URL does not have to be truncated to the root, it can be to any resource on the URL. | url (string) |
| get_org_by_org_id_report_login | Returns the login report for the organization. This reports list the total number of users and the total number of active users per week. | org_id (string) required limit (string) offset (string) |
| get_org_by_org_id_member | Returns the members, both invited and active, of the given organization. This method is only available for organization administrators. For users only invited, only very limited information will be returned for the user and profile. | org_id (string) required limit (string) member_type (string) offset (string) query (string) sort_by (string) sort_desc (string) |
| get_org_shared_by_user_id | Returns the organizations and spaces that the logged in user shares with the specified user. The organizations and spaces will be returned sorted by name. | user_id (string) required |
| get_org_by_org_id_space_url_by_url | Return the space with the given URL on the space. To get the space related to http://company.podio.com/intranet, first lookup the organization on 'company' and then the space using this function using the URL 'intranet'. | org_id (string) required url (string) required |
| get_org_by_org_id_member_by_user_id_space_member | Returns all space memberships the specified org member has in this organization. If the org admin requesting this information is not a member of any of these workspaces, sensitive information like name and url will not be exposed. | org_id (string) required user_id (string) required |
| get_org_by_org_id_space | Returns all the spaces for the organization. | org_id (string) required |
| get_org_by_org_id_member_search | Searches organization members by name | org_id (string) required |
| post_question_by_question_id | Answers the question for the given object. The object type can be either 'status' or 'comment'. | question_id (string) required data: { . question_option_id (string) } (object) required |
| get_question_by_question_id | Returns all the answers for the given question on the given object. | question_id (string) required |
| post_question_by_ref_type_by_ref_id | Creates a new question on the given object. Supported object types are 'status' and 'comment'. | ref_type (string) required ref_id (string) required data: { . text (string) . options (string) } (object) required |
| post_rating_by_ref_type_by_ref_id_by_rating_type | Add a new rating of the user to the object. The rating can be one of many different types. For more details see the area. | ref_type (string) required ref_id (string) required rating_type (string) required data: { . value (string) } (object) required |
| get_rating_by_ref_type_by_ref_id_by_rating_type | Get the rating average for fivestar and totals for the given rating type on the specified object. | ref_type (string) required ref_id (string) required rating_type (string) required |
| delete_rating_by_ref_type_by_ref_id_by_rating_type | Removes a previous rating of the given type by the user of the specified object. | ref_type (string) required ref_id (string) required rating_type (string) required |
| get_rating_by_ref_type_by_ref_id | Returns all the ratings for the given object. It will only return the ratings that are enabled for the object. | ref_type (string) required ref_id (string) required |
| get_rating_by_ref_type_by_ref_id_like_count | Get the number of users who liked the given object. | ref_type (string) required ref_id (string) required |
| get_rating_by_ref_type_by_ref_id_by_rating_type_by_user_id | Returns the rating value for the given rating type, object and user. | ref_type (string) required ref_id (string) required rating_type (string) required user_id (string) required |
| get_rating_by_ref_type_by_ref_id_by_rating_type_self | Returns the active users rating value for the given rating type and object. | ref_type (string) required ref_id (string) required rating_type (string) required |
| get_rating_by_ref_type_by_ref_id_liked_by | Get a list of profiles of everyone that liked the given object. | ref_type (string) required ref_id (string) required limit (string) |
| put_recurrence_by_ref_type_by_ref_id | Creates or updates recurrence on the object | ref_type (string) required ref_id (string) required data: { . name (string) . config (string) . days (string) . repeat_on (string) . step (string) . until (string) } (object) required |
| delete_recurrence_by_ref_type_by_ref_id | Deletes the recurrence | ref_type (string) required ref_id (string) required |
| get_recurrence_by_ref_type_by_ref_id | Returns the recurrence for the given object | ref_type (string) required ref_id (string) required |
| get_reference_by_ref_type_by_ref_id_accessible_by_count | Returns the number of other users with access to the given object. | ref_type (string) required ref_id (string) required |
| get_reference_by_ref_type_by_ref_id | Returns information about the reference | ref_type (string) required ref_id (string) required accessor_count (string) context_id (string) context_type (string) |
| get_reference_by_ref_type_by_ref_id_accessible_by | Returns user profiles who have access to an object, either because they have been explicitly granted access to it or because they are members of the object's workspace. | ref_type (string) required ref_id (string) required limit (string) offset (string) |
| get_reference_resolve | Resolves the url given in the parameter to a reference. If the URL could not be resolved, status code 404 will be returned. If the user does not have access to the URL, status code 403 will be returned. | url (string) |
| post_reference_search | Search for references for use in various contexts. | data: { . target (string) . target_params (string) . text (string) . limit (string) } (object) required |
| put_reminder_by_ref_type_by_ref_id | Creates or updates the reminder on a object. Possible ref_types are: | ref_type (string) required ref_id (string) required data: { . remind_delta (string) } (object) required |
| delete_reminder_by_ref_type_by_ref_id | Deletes the reminder, if any, on the given object | ref_type (string) required ref_id (string) required reminder_id (string) |
| get_reminder_by_ref_type_by_ref_id | Returns the reminder for the given object | ref_type (string) required ref_id (string) required |
| post_reminder_by_ref_type_by_ref_id_snooze | Snoozes the reminder for 10 minutes | ref_type (string) required ref_id (string) required data: { . reminder_id (string) } (object) required |
| get_search_appby_app_id_space_by_space_id | Searches in all items, files, and tasks in the app and space. | app_id (string) required space_id (string) required |
| post_search | Searches in all items, statuses, profiles, files, meetings and non-private tasks. The objects will be returned sorted descending by the time the object was created. | data: { . search_fields (string) } (object) required |
| get_search_v2 | Searches in all conversations, profiles, statuses, items, files, and tasks. The objects will be returned sorted descending by the time the object had any update. | counts (string) highlights (string) limit (string) offset (string) query (string) ref_type (string) search_fields (string) |
| post_search_app_by_app_id | Searches in all items and tasks in the app. | app_id (string) required data: { . search_fields (string) } (object) required |
| get_search_app_by_app_id_v2 | Searches in all items, files, and tasks in the application. The objects will be returned sorted descending by the time the object had any update. | app_id (string) required counts (string) highlights (string) limit (string) offset (string) query (string) ref_type (string) search_fields (string) |
| post_search_org_by_org_id | Searches in all items, statuses and non-private tasks in the organization. | org_id (string) required data: { . search_fields (string) } (object) required |
| get_search_org_by_org_id_v2 | Searches in all items, statuses, files, profiles, apps and non-private tasks in the organization. The objects will be returned sorted descending by the time the object had any update. | org_id (string) required counts (string) highlights (string) limit (string) offset (string) query (string) ref_type (string) search_fields (string) |
| post_search_space_by_space_id | Searches in all items, statuses and non-private tasks in the space. The objects will be returned sorted descending by the time the object had any update. | space_id (string) required data: { . search_fields (string) } (object) required |
| get_search_space_by_space_id_v2 | Searches in all items, statuses, files, profiles, apps and tasks in the space. The objects will be returned sorted descending by the time the object had any update. | space_id (string) required counts (string) highlights (string) limit (string) offset (string) query (string) ref_type (string) search_fields (string) |
| post_space_by_space_id_member_request_by_space_member_request_id_accept | Accept a request from another user to be added to the space. | space_id (string) required space_member_request_id (string) required |
| post_space_by_space_id_member | Adds a list of users either through user_id or email to the space. If the user limit is reached, status code 403 will be returned. | space_id (string) required data: { . role (string) . message (string) . users (string) . profiles (string) . mails (string) . external_contacts (string) . context_ref_type (string) . context_ref_id (string) } (object) required |
| get_space_by_space_id_member | Returns the active members of the given space. | space_id (string) required |
| delete_space_by_space_id_member_by_user_ids | Ends all the users membership on the space, can also be called for members in state invited. | space_id (string) required user_ids (string) required |
| put_space_by_space_id_member_by_user_ids | Updates the space memberships with another role | space_id (string) required user_ids (string) required data: { . role (string) } (object) required |
| get_space_by_space_id_member_total | Returns the total number of internal and external space members on the space | space_id (string) required |
| get_space_by_space_id_member_by_user_id_v2 | Returns the membership details for the given user on the given space. | space_id (string) required user_id (string) required |
| get_space_by_space_id_member_by_role | Returns the space members with the specified role. | space_id (string) required role (string) required |
| get_space_by_space_id_member_v2 | Returns the members of the given space | space_id (string) required limit (string) member_type (string) offset (string) query (string) |
| get_space_by_space_id_member_by_user_id | Used to get the details of an active users membership of a space. | space_id (string) required user_id (string) required |
| post_space_by_space_id_join | Joins the open space with the given id | space_id (string) required |
| post_space_by_space_id_member_request | Request access to a space you don't have access to. All admins of this space will get notified and can accept or ignore it. | space_id (string) required |
| post_space_by_space_id_archive | Archives the workspace. This hides it from navigation, but doesn't do anything other than that. | space_id (string) required |
| post_space | Add a new space to an organization. | data: { . org_id (string) . privacy (string) . name (string) . post_on_new_app (string) . post_on_new_member (string) } (object) required |
| delete_space_by_space_id | Deletes the space with the given id. This will also end all memberships of the space and cancel any space invites still outstanding. | space_id (string) required |
| get_space_by_space_id | Get the space with the given id | space_id (string) required |
| put_space_by_space_id | Updates the space with the given id | space_id (string) required data: { . name (string) . privacy (string) . auto_join (string) . url_label (string) . post_on_new_app (string) . post_on_new_member (string) } (object) required |
| get_space_by_space_id_available | Returns the available seats. A null value means there is an unlimited number of available seats. | space_id (string) required |
| get_space_org_by_org_id_available | Returns the available spaces for the given organization. This is spaces that are open and available for the user to join. | org_id (string) required |
| get_space_org_by_org_id | Returns the workspaces in the organization that are accesible for the active user. | org_id (string) required |
| get_space_org_by_org_id_url_by_url_label | Returns the space in the given org with the given URL label | org_id (string) required url_label (string) required |
| get_space_url | Returns the space and organization with the given full URL. | org_slug (string) space_slug (string) url (string) |
| get_space_top | Returns the top spaces for the user | limit (string) |
| post_space_by_space_id_restore | Restores an archived workspace. This unhides it from navigation, but doesn't do anything other than that. | space_id (string) required |
| post_status_space_by_space_id | Creates a new status message for a user on a specific space. A status update is simply a short text message that the user wishes to share with the rest of the space. | space_id (string) required data: { . alert_invite (string) } (object) required |
| delete_status_by_status_id | This is used to delete a status message. This is normally only done if the user regrets his status update. After deletion the status message will no longer be viewable by anyone. | status_id (string) required |
| get_status_by_status_id | Retrieves a status message by its id. The id of the status message is usually gotten from the stream. | status_id (string) required |
| put_status_by_status_id | This will update an existing status message. This will normally only be used to correct spelling and grammatical mistakes. | status_id (string) required data: { . file_ids (array) . embed_id (string) . embed_url (string) } (object) required |
| post_stream_app_by_app_id_filter | Returns the stream for the given app filtered using the item filters. | app_id (string) required |
| get_stream_app_by_app_id | Returns the stream for the given app. This includes items from the app and tasks on the app. | app_id (string) required limit (string) offset (string) |
| get_stream_app_by_app_id_v3 | Get stream for an application | app_id (string) required groups_event_types (string) groups_limit (string) limit (string) offset (string) |
| get_stream | Returns the global stream. The types of objects in the stream can be either 'item', 'status', 'task', 'action', 'file' or'item_transaction'. The data part of the result depends on the type of object and is specified below: | limit (string) offset (string) |
| get_stream_v3 | Get global stream - version 3 | groups_event_types (string) groups_limit (string) limit (string) offset (string) |
| get_stream_by_ref_type_by_ref_id_activity_group_by_data_ref_type_by_data_ref_id | Return the activity group for the given ref and data ref | ref_type (string) required ref_id (string) required data_ref_type (string) required data_ref_id (string) required event_types (string) |
| get_stream_by_ref_type_by_ref_id_group_by_event_id | Return group in which event with event_id is in | ref_type (string) required ref_id (string) required event_id (string) required event_types (string) |
| get_stream_by_ref_type_by_ref_id_activity_group | Get grouped events for the given reference. The groups are returned in descending order, with the most recent group in the top. | ref_type (string) required ref_id (string) required event_types (string) from_groupd_id (string) limit (string) offset (string) to_group_id (string) |
| get_stream_org_by_org_id_v3 | Get stream for an organization - version 3 | org_id (string) required groups_event_types (string) groups_limit (string) limit (string) offset (string) |
| get_stream_org_by_org_id | Returns the activity stream for the given organization. | org_id (string) required limit (string) offset (string) |
| get_stream_space_by_space_id | Returns the activity stream for the space. | space_id (string) required limit (string) offset (string) |
| get_stream_space_by_space_id_v3 | Get stream for a space - version 3 | space_id (string) required groups_event_types (string) groups_limit (string) |
| get_stream_by_ref_type_by_ref_id | Returns an object of type 'item', 'status' or 'task' as a stream object. This is useful when a new status has been posted and should be rendered directly in the stream without reloading the entire stream. | ref_type (string) required ref_id (string) required |
| get_stream_by_ref_type_by_ref_id_v3 | Get stream view of an object - version 3 | ref_type (string) required ref_id (string) required groups_event_types (string) groups_limit (string) |
| get_stream_user_by_user_id | Returns the stream for the given user. This returns all objects the active user has access to sorted by the given user last touched the object. | user_id (string) required limit (string) offset (string) |
| get_stream_user_by_user_id_v3 | Get stream for an user - version 3 | user_id (string) required groups_event_types (string) groups_limit (string) limit (string) offset (string) |
| get_subscription_inactive | Returns the subscriptions to spaces and apps, where the user have not been active recently. | No parameters |
| get_subscription_by_subscription_id | Returns the subscription with the given id | subscription_id (string) required |
| delete_subscription_by_subscription_id | Stops the subscription with the given id | subscription_id (string) required |
| get_subscription_by_ref_type_by_ref_id | Get the subscription for the given object | ref_type (string) required ref_id (string) required |
| post_subscription_by_ref_type_by_ref_id | Subscribes the user to the given object. Based on the object type, the user will receive notifications when actions are performed on the object. See the area for more details. | ref_type (string) required ref_id (string) required |
| delete_subscription_by_ref_type_by_ref_id | Unsubscribe from getting notifications on actions on the given object. | ref_type (string) required ref_id (string) required |
| post_tag_by_ref_type_by_ref_id | Adds additional tags to the object. If a tag with the same text is already present, the tag will be ignored. Existing tags on the object are preserved. | ref_type (string) required ref_id (string) required |
| delete_tag_by_ref_type_by_ref_id | Removes a single tag from an object. | ref_type (string) required ref_id (string) required text (string) |
| put_tag_by_ref_type_by_ref_id | Updates the tags on the given object. Existing tags on the object will be overwritten. Use Create Tags operation to preserve existing tags. | ref_type (string) required ref_id (string) required |
| get_tag_app_by_app_id_search_full | You can simulate the API request by filling out the arguments below, and press the submit button to see the response. | app_id (string) required |
| get_tag_app_by_app_id_search | Returns the objects that are tagged with the given text on the app. The objects are returned sorted descending by the time the tag was added. | app_id (string) required text (string) |
| get_tag_org_by_org_id_search | Returns the objects that are tagged with the given text on the organization. The objects are returned sorted descending by the time the tag was added. | org_id (string) required text (string) |
| get_tag_space_by_space_id_search | Returns the objects that are tagged with the given text on the space. The objects are returned sorted descending by the time the tag was added. | space_id (string) required text (string) |
| get_tag_app_by_app_id | Returns the tags on the given app. This includes only items. The tags are first limited ordered by their frequency of use, and then returned sorted alphabetically. | app_id (string) required limit (string) text (string) |
| get_tag_app_by_app_id_top | Returns the top tags on the app. | app_id (string) required limit (string) text (string) |
| get_tag_org_by_org_id | Returns the tags on the given org. This includes both items and statuses on all spaces in the organization that the user is part of. The tags are first limited ordered by their frequency of use, and then returned sorted alphabetically. | org_id (string) required limit (string) text (string) |
| get_tag_space_by_space_id | Returns the tags on the given space. This includes both items and statuses. The tags are first limited ordered by their frequency of use, and then returned sorted alphabetically. | space_id (string) required limit (string) text (string) |
| post_task_by_task_id_assign | Assigns the task to another user. This makes the user responsible for the task and its completion. | task_id (string) required data: { . silent (string) } (object) required |
| post_task_by_task_id_complete | Mark the given task as completed. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| post_task_label | Creates a new personal label for the user. | data: { . text (string) . color (string) } (object) required |
| get_task_label | Returns the users task labels. | No parameters |
| post_task | Creates a new task. | data: { . hook (string) . silent (string) } (object) required |
| get_task | Returns a list of all tasks matching all given filters and grouped by the specified group. | app (string) completed (string) completed_by (string) completed_on (string) created_by (string) created_on (string) created_via (string) due_date (string) external_id (string) files (string) grouping (string) label (string) limit (string) offset (string) org (string) reassigned (string) reference (string) responsible (string) sort_by (string) sort_desc (string) space (string) view (string) |
| post_task_by_ref_type_by_ref_id | Creates a new task with a reference to the given object. The valid types of objects are 'item', 'status', 'app', 'space' and 'conversation'. | ref_type (string) required ref_id (string) required data: { . hook (string) . silent (string) } (object) required |
| get_task_by_ref_type_by_ref_id | Gets a list of tasks with a reference to the given object. This will return both active and completed tasks. The reference will not be set on the individual tasks. | ref_type (string) required ref_id (string) required |
| delete_task_label_by_label_id | Deletes the label with the given id. This will remove the label from all tasks. | label_id (string) required |
| put_task_label_by_label_id | Updates the label with the given id | label_id (string) required data: { . text (string) . color (string) } (object) required |
| delete_task_by_task_id | Deletes the task with the given id. | task_id (string) required hook (string) silent (string) |
| get_task_by_task_id | Returns the task with the given id. | task_id (string) required |
| put_task_by_task_id | Updates the task with the given attributes. Any attributes not specified will remain unchanged. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| get_task_by_ref_type_by_ref_id_count | Returns the total open tasks for the user on the reference. | ref_type (string) required ref_id (string) required |
| get_task_summary | Returns the task summary for the active user | limit (string) |
| get_task_org_by_org_id_summary | Returns the task summary for the organization for the active user | org_id (string) required limit (string) |
| get_task_personal_summary | Returns the tasks summary for personal tasks and tasks on personal spaces and sub-orgs. | limit (string) |
| get_task_by_ref_type_by_ref_id_summary | Returns the task summary for the given object. | ref_type (string) required ref_id (string) required limit (string) |
| get_task_space_by_space_id_summary | Returns the task summary for the given space for the active user | space_id (string) required limit (string) |
| get_task_total_by_time | Returns the total number of tasks for the given time. The valid values for time are: 'overdue', 'due', 'today' and 'all' | time (string) required space_id (string) |
| get_task_total | Get the totals for the users active tasks. | space (string) |
| post_task_by_task_id_incomplete | Mark the completed task as no longer being completed. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| post_task_by_task_id_rank | Ranks the task in comparision to one or two other tasks. | task_id (string) required data: { . after (string) . before (string) } (object) required |
| delete_task_by_task_id_ref | Deletes the reference on the task | task_id (string) required |
| put_task_by_task_id_ref | Attached this task to an object. If the task is already attached to an object, it will be detached from that object and reattached on the new object. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| put_task_by_task_id_description | Updates the description of the task. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| put_task_by_task_id_due | Updates the due on property on the task | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| put_task_by_task_id_label | Updates the task with new labels | task_id (string) required |
| put_task_by_task_id_private | Update the private flag on the given task. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| put_task_by_task_id_text | Updates the text of the task. | task_id (string) required data: { . hook (string) . silent (string) } (object) required |
| delete_user_property_by_name | Deletes the property for the active user with the given name. The property is specific to the auth client used. | name (string) required |
| get_user_property_by_name | Returns the value of the property for the active user with the given name. The property is specific to the auth client used. | name (string) required |
| put_user_property_by_name | Sets the value of the property for the active user with the given name. The property is specific to the auth client used. | name (string) required |
| get_user_setting_by_client_type_by_notification_type | Get's the setting for the given client type and notification type. | client_type (string) required notification_type (string) required |
| put_user_setting_by_client_type_by_notification_type | Updates the setting for the given client type and notification type. | client_type (string) required notification_type (string) required data: { . value (string) } (object) required |
| get_user_setting_by_client_type | Get's the setting for the given client type | client_type (string) required |
| put_user_setting_by_client_type | Updates the setting for the given client type | client_type (string) required |
| get_user_profile | Returns the profile of the active user | No parameters |
| put_user_profile | Updates the fields of an existing profile. Fields not specified will not be updated. To delete a field set the value of the field to null. | No parameters |
| get_user_profile_by_key | Returns the field of the profile for the given key from the active user. For a list of valid keys and their possible values, see the contact area. | key (string) required |
| put_user_profile_by_key | Updates the specific field on the user | key (string) required data: { . value (string) } (object) required |
| get_user | Gets the active user. | No parameters |
| get_user_status | Returns the current status for the user. This includes the user data, profile data and notification data. | No parameters |
| put_user_property | Sets the values of one or more properties for the active user. The properties are specific to the auth client used. | data: { . property_name (string) } (object) required |
| post_view_app_by_app_id | Creates a new view on the given app. | app_id (string) required data: { . name (string) . sort_by (string) . sort_desc (string) . filters (string) . key (string) . values (string) . layout (string) . fields (string) . delta_offset (string) . width (string) . hidden (string) . use (string) . grouping (string) } (object) required |
| get_view_app_by_app_id | Returns the views on the given app. | app_id (string) required include_standard_views (string) |
| delete_view_by_view_id | Deletes the given view | view_id (string) required |
| put_view_by_view_id | Updates the given view | view_id (string) required |
| get_view_app_by_app_id_by_view_id_or_name | Returns the definition for the given view. The view can be either a view id, a standard view or 'last' for the last view used. | app_id (string) required view_id_or_name (string) required |
| post_view_by_view_id_default | Makes the view with the given id the default view for the app. The view must be of type 'saved' and must be active. In addition the user most have right to update the app. | view_id (string) required |
| put_view_app_by_app_id_last | Updates the last view for the active user | app_id (string) required data: { . sort_by (string) . sort_desc (string) . filters (string) . key (string) . values (string) . layout (string) . fields (string) . delta_offset (string) . width (string) . hidden (string) . use (string) } (object) required |
| put_voting_app_by_app_id_voting | Update app voting with new voting's provided in body. | app_id (string) required |
| post_voting_app_by_app_id_voting | Create voting of kind specified in request body to application | app_id (string) required |
| get_voting_app_by_app_id_voting | Resturn application Votings in user-defined order. | app_id (string) required |
| put_voting_by_voting_id_answer_order | Change order of answers presentation in possible voting. | voting_id (string) required |
| put_voting_app_by_app_id_voting_order | Set voting order in scope of application | app_id (string) required |
| post_voting_by_voting_id_answers | Create answer in application voting. | voting_id (string) required |
| delete_voting_answer_by_answer_id | Delete Answer in Voting | answer_id (string) required |
| put_voting_answer_by_answer_id | Changes text of Answer in Voting | answer_id (string) required |
| delete_voting_by_voting_id | Delete specified Voting | voting_id (string) required |
| get_voting_by_voting_id | Return one voting object | voting_id (string) required |
| put_voting_by_voting_id | Update voting question with question specified in POST in Voting. | voting_id (string) required |
| get_voting_item_by_item_id_voting_by_voting_id_user | Return profiles of user that has voted in specified way by parameter value. | item_id (string) required voting_id (string) required value (string) |
| get_voting_item_by_item_id_voting_by_voting_id_result | Get result of voting on an item. | item_id (string) required voting_id (string) required max_voters (string) |
| get_voting_item_by_item_id_result | Get result of voting on an item. | item_id (string) required max_voters (string) |
| delete_voting_item_by_item_id_voting_by_voting_id_votes | Delete user vote on an item in concrete voting object | item_id (string) required voting_id (string) required |
| post_voting_item_by_item_id_voting_by_voting_id_votes | Vote on an item - rating voting | item_id (string) required voting_id (string) required |
| post_widget_by_widget_id_clone | Clones the widget to a new position. The widget will be placed at the bottom of existing widgets. | widget_id (string) required |
| post_widget_by_ref_type_by_ref_id | Create a new widget on the given reference. Supported references are organizations, spaces, apps and users. Not all widgets types can references all of the reference types, e.g. a widget of type 'apps' can only reference a user. | ref_type (string) required ref_id (string) required data: { . type (string) . title (string) . config (string) } (object) required |
| get_widget_by_ref_type_by_ref_id | Returns the widgets on the given reference for display. This includes the current data to be shown in the widgets. | ref_type (string) required ref_id (string) required |
| delete_widget_by_widget_id | Deletes the given widget. | widget_id (string) required |
| get_widget_by_widget_id | Returns the widget with the given id. | widget_id (string) required |
| put_widget_by_widget_id | Updates a widget with a new title and configuration. | widget_id (string) required data: { . title (string) . config (string) } (object) required |
| put_widget_by_ref_type_by_ref_id_order | Updates the order of the widgets on a reference. The ids of the widgets should be put in the new requested order. | ref_type (string) required ref_id (string) required |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |