Skip to main content

Podio

Project management and collaboration platform by Citrix.

Podio Logo

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 419 actions:

ActionPurposeParameters
get_action_by_action_idReturns the action with the given idaction_id (string)
get_app_store_categoryReturns the categories available in the system.only_used (string)
get_app_store_orgReturns all the orgs, that the user is member of, and that has shared private apps.No parameters
get_app_store_by_type_ownReturns all the apps that the active user has shared.type (string)
limit (string)
offset (string)
get_app_store_by_type_recommended_by_areaReturns the recommended apps in the app market for the given 'area'. Current areas are: 'web' and 'mobile'.type (string)
area (string)
get_app_store_by_share_id_v2Returns 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)
get_app_store_by_ref_type_by_ref_idReturns 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)
ref_id (string)
get_app_store_by_type_author_by_user_idReturns all the apps in the app market created by the given user in the given language.type (string)
user_id (string)
limit (string)
offset (string)
sort (string)
get_app_store_by_type_category_by_category_idReturns the apps in the app market in the given category and language.type (string)
category_id (string)
limit (string)
offset (string)
sort (string)
get_app_store_by_type_topReturns the top apps in the app market in the given language.type (string)
limit (string)
offset (string)
post_app_store_by_share_id_installInstalls the share with the given id on the space.share_id (string)
data: {
. space_id (string)
. dependencies (string)
} (object) required
post_app_storeShares 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_idUnshares the given app from the app marketshare_id (string)
put_app_store_by_share_idUpdates the share with changes to abstract, description, etc.share_id (string)
data: {
. name (string)
. abstract (string)
. description (string)
. language (string)
. category_ids (string)
. file_ids (string)
} (object) required
post_app_by_app_id_activateActivates a deactivated app. This puts the app back in the app navigator and allows insertion of new items.app_id (string)
post_appCreates a new app on a space.data: {
. silent (string)
} (object) required
get_appReturns 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_fieldAdds a new field to an appapp_id (string)
data: {
. type (string)
. description (string)
. delta (string)
} (object) required
post_app_by_app_id_deactivateDeactivates the app with the given id. This removes the app from the app navigator, and disables insertion of new items.app_id (string)
delete_app_by_app_idDeletes 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)
silent (string)
get_app_by_app_idGets 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)
put_app_by_app_idUpdates 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)
data: {
. silent (string)
} (object) required
delete_app_by_app_id_field_by_field_idDeletes 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)
field_id (string)
delete_values (string)
put_app_by_app_id_field_by_field_idUpdates the configuration of an app field. The type of the field cannot be updated, only the configuration.app_id (string)
field_id (string)
data: {
. label (string)
. description (string)
. delta (string)
. mapping (string)
} (object) required
get_app_org_by_org_label_space_by_space_label_by_app_labelReturns app based on the provided org_label, space_label and app_label.org_label (string)
space_label (string)
app_label (string)
get_app_by_app_id_dependenciesReturns the apps that the given app depends on.app_id (string)
get_app_by_app_id_field_by_field_or_external_idReturns a single field from an app.app_id (string)
field_or_external_id (string)
get_app_by_app_id_inverse_dependenciesReturns the apps that depend on the given app_id.app_id (string)
get_app_space_by_space_id_by_url_labelReturns the app on the given space with the given URL labelspace_id (string)
url_label (string)
get_app_space_by_space_idReturns all the apps on the space that are visible. The apps are sorted by any custom ordering and else by name.space_id (string)
include_inactive (string)
get_app_featuresReturns 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_searchAny search term to match.query (string)
get_space_by_space_id_dependenciesReturns all the active apps on the space along with their dependencies. The dependencies are only one level deep.space_id (string)
get_app_topReturns 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_topReturns the top apps for the user inside the given organizationorg_id (string)
post_app_by_app_id_installInstalls the app with the given id on the space.app_id (string)
data: {
. features (string)
} (object) required
put_app_by_app_id_descriptionUpdates the app with a new descriptionapp_id (string)
data: {
. silent (string)
} (object) required
put_app_space_by_space_id_orderUpdates the order of the apps on the space. It should post all the apps from the space in the order required.space_id (string)
put_app_by_app_id_usageUpdates the usage instructions for the appapp_id (string)
data: {
. silent (string)
} (object) required
put_app_by_app_id_v2Updates 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)
data: {
. silent (string)
} (object) required
get_batch_by_batch_idReturns the batch with the given idbatch_id (string)
get_batchReturns 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_runningReturns 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)
ref_id (string)
plugin (string)
post_calendar_app_by_app_id_filterReturns the calendar for the given app filtered using the item filters.app_id (string)
get_calendar_app_by_app_idReturns the items and tasks that are related to the given app.app_id (string)
date_from (string)
date_to (string)
priority (string)
tasks (string)
get_calendar_app_by_app_id_ics_by_user_id_by_tokenReturns 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)
user_id (string)
token (string)
tasks (string)
get_calendar_summaryReturns the calendar summary for the active userlimit (string)
priority (string)
get_calendar_personal_summaryReturns the calendar summary for personal tasks and personal spaces and sub-orgs.limit (string)
priority (string)
get_calendar_space_by_space_id_summaryReturns the calendar summary for the given space for the active userspace_id (string)
limit (string)
priority (string)
get_calendar_export_linked_account_by_linked_account_id_by_ref_type_by_ref_idReturns the current export for the current linked account and reflinked_account_id (string)
ref_type (string)
ref_id (string)
get_calendar_export_by_ref_type_by_ref_idReturns the calendar exports for the given reference. Valid reference types are 'app' and 'space'.ref_type (string)
ref_id (string)
get_calendarReturns 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_tokenReturns 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)
token (string)
tasks (string)
get_calendar_export_linked_account_by_linked_account_idYou can simulate the API request by filling out the arguments below, and press the submit button to see the response.linked_account_id (string)
get_calendar_exportReturns the exports configured for the global calendarNo parameters
get_calendar_item_by_item_id_field_by_field_id_icsReturns the calendar for the given date field of the given item in the iCal format.item_id (string)
field_id (string)
get_calendar_linked_account_by_linked_account_idReturns the events in the primary calendar of the linked account in the given intervallinked_account_id (string)
date_from (string)
date_to (string)
get_calendar_space_by_space_idReturns 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)
date_from (string)
date_to (string)
priority (string)
tasks (string)
get_calendar_space_by_space_id_ics_by_user_id_by_tokenReturns 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)
user_id (string)
token (string)
tasks (string)
get_calendar_task_by_task_id_icsReturns the calendar for the given task in the iCal format.task_id (string)
post_calendar_linked_account_by_linked_account_id_event_by_uid_moveMove event in external calendar linked by linked_accountlinked_account_id (string)
uid (string)
data: {
. day_delta (string)
} (object) required
put_calendar_event_by_uidUpdate 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)
put_calendar_linked_account_by_linked_account_id_event_by_uid_durationChange duration of external eventlinked_account_id (string)
uid (string)
data: {
. day_delta (string)
} (object) required
post_comment_by_type_by_idAdds a new comment to the object of the given type and id, f.ex. item 1.type (string)
id (string)
data: {
. alert_invite (string)
. hook (string)
. silent (string)
} (object) required
get_comment_by_type_by_idUsed 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)
id (string)
limit (string)
offset (string)
delete_comment_by_comment_idDeletes 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)
hook (string)
get_comment_by_comment_idReturns the contents of a comment. It is not possible to see where the comment was made, only the comment itself.comment_id (string)
put_comment_by_comment_idUpdates an already created comment. This should only be used to correct spelling and grammatical mistakes in the comment.comment_id (string)
data: {
. external_id (string)
. file_ids (string)
. embed_id (string)
. embed_url (string)
} (object) required
get_comment_by_comment_id_revisionReturns all the revisions on the given comment, including the current revision. Revisions are returned with the oldest first.comment_id (string)
post_contact_space_by_space_idCreates a new space contact for use by everyone on the space.space_id (string)
data: {
. external_id (string)
} (object) required
get_contact_space_by_space_idReturns 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)
field (string)
contact_type (string)
exclude_self (string)
limit (string)
offset (string)
order (string)
required (string)
type (string)
delete_contact_by_profile_idsDeletes the contacts with the given ids. It is currently only allowed to delete contacts of type 'space'.profile_ids (string)
get_contact_totalsReturns the total number of contacts for the active user.exclude_self (string)
get_contact_totals_v3Returns the total number of contacts for the active user.No parameters
get_contact_by_profile_ids_v2Returns all the contact details about the contacts with the given profile ids.profile_ids (string)
space_id (string)
get_contactUsed 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_idLoads the contact from the given linked account with the given external id. The linked account must support the 'contacts' capability.linked_account_id (string)
data: {
. external_contact_id (string)
} (object) required
get_contact_linked_account_by_linked_account_idLoads the contacts from the given linked account. The linked account must support the 'contacts' capability.linked_account_id (string)
contactable (string)
limit (string)
name (string)
offset (string)
get_contact_org_by_org_idReturns 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)
field (string)
contact_type (string)
exclude_self (string)
limit (string)
offset (string)
order (string)
required (string)
type (string)
get_contact_skillReturns the skills of related contacts, ordered by most frequently used.limit (string)
text (string)
get_contact_space_by_space_id_totals_spaceReturns the total number of contacts on the spacespace_id (string)
get_contact_app_by_app_idReturns all the space contacts referenced by the given app.app_id (string)
field (string)
limit (string)
offset (string)
order (string)
get_contact_user_by_user_idReturns the contact with the given user id.user_id (string)
get_contact_user_by_user_id_by_keyReturns the value of a contact with the specific field. For the possible keys to use, see the area.user_id (string)
key (string)
get_contact_by_profile_id_vcardReturns the vCard for the given contact.profile_id (string)
put_contact_by_profile_idUpdates the contact with the given profile id. It is currently only possible to update contacts of type 'space'.profile_id (string)
put_contact_by_profile_id_by_keyUpdates the given field on the given contact. Updates are currently only allowed from contacts of type 'space'.profile_id (string)
key (string)
data: {
. value (string)
} (object) required
post_conversation_by_conversation_id_participantAdds new participants to the conversation.conversation_id (string)
data: {
. participants (string)
} (object) required
post_conversation_by_conversation_id_participant_v2Adds new participants to the conversation.conversation_id (string)
data: {
. participants (string)
} (object) required
post_conversationCreates 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_conversationReturns all the users conversations ordered by time of the last event.limit (string)
offset (string)
post_conversation_by_ref_type_by_ref_idCreates a new conversation on the given object. Works similarly to the create notification method in other regards.ref_type (string)
ref_id (string)
get_conversation_by_ref_type_by_ref_idReturns a list of all the conversations on the object that the active user is part of.ref_type (string)
ref_id (string)
post_conversation_v2Creates 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_idGets the conversation including participants with the the given id. Only participants in the conversation is allowed to view the conversation.conversation_id (string)
get_conversation_event_by_event_idReturns data about the given event.event_id (string)
get_conversation_by_conversation_id_eventReturns the events on the conversation.conversation_id (string)
limit (string)
offset (string)
get_conversation_direct_by_user_idReturns the existing direct conversation with the user. If none exists a 404 will be returned.user_id (string)
get_conversation_by_flag_countReturns the number of conversations with the given flag. The flag can be one of:flag (string)
get_conversation_by_flagReturns the conversations with the given flag. The flag can be one of:flag (string)
limit (string)
offset (string)
post_conversation_by_conversation_id_leaveLeave the given conversation.conversation_id (string)
post_conversation_readMarks all the users conversations as read.No parameters
post_conversation_by_conversation_id_readMark the conversation as read.conversation_id (string)
delete_conversation_by_conversation_id_readMark the conversation as unreadconversation_id (string)
post_conversation_by_conversation_id_replyCreates a reply to the conversation.conversation_id (string)
data: {
. text (string)
. embed_id (array)
. embed_url (string)
} (object) required
post_conversation_by_conversation_id_reply_v2Creates a reply to the conversation. Returns the conversation event this generates.conversation_id (string)
get_conversation_searchReturns the users conversations that match the given text ordered by time of the last event.limit (string)
offset (string)
post_conversation_by_conversation_id_starStar the given conversation. If the conversation is already starred, nothing will happen.conversation_id (string)
delete_conversation_by_conversation_id_starRemoves the star from the conversation.conversation_id (string)
post_mobile_install_app_by_app_idPushes the app to the active users mobile phones.app_id (string)
post_email_contact_by_name_by_ref_type_by_ref_id_exportExports 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)
ref_type (string)
ref_id (string)
data: {
. linked_account_id (string)
} (object) required
post_email_contact_by_name_exportExports the email contact for the given name to the linked account given in the body. Valid names are:name (string)
data: {
. linked_account_id (string)
} (object) required
get_email_app_by_app_idReturns the current email configuration for the given appapp_id (string)
put_email_app_by_app_idUpdates the app email configurationapp_id (string)
data: {
. attachments (string)
. mappings (string)
} (object) required
get_email_contact_by_name_by_ref_type_by_ref_idReturn the email contact for the given reference and name. Valid combinations of name and ref_type is:name (string)
ref_type (string)
ref_id (string)
get_email_contact_by_name_by_ref_type_by_ref_id_vcardReturn the email contact for the given reference and name. Valid combinations of name and ref_type is:name (string)
ref_type (string)
ref_id (string)
get_email_contact_by_nameReturns the email contact for the given name. Valid names are:name (string)
get_email_contact_by_name_vcardReturns the email contact as a vcard for the given name. Valid names are:name (string)
get_email_groupReturns the subscription status for all the email groups.No parameters
put_email_groupUpdates the email groups the user is subscribed to.data: {
. digest (string)
. bulletin (string)
} (object) required
post_embedGrabs metadata and returns metadata for the given url such as title, description and thumbnails.data: {
. url (string)
} (object) required
post_file_by_file_id_attachAttaches the uploaded file to the given object. Valid objects are 'status', 'item', 'comment', 'space', or 'task'.file_id (string)
data: {
. silent (string)
} (object) required
post_file_by_file_id_copyCopies the file, which makes it available for attaching to another object.file_id (string)
delete_file_by_file_idDeletes the file with the given id.file_id (string)
get_file_by_file_idReturns the file with the given idfile_id (string)
put_file_by_file_idUsed to update the description of the file.file_id (string)
data: {
. description (string)
} (object) required
get_fileReturns 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_fileUploads 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_idReturns 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)
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_idReturns all the files on the space order by the file name.space_id (string)
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_latestReturns the latest files on the space order descending by the date the file was uploaded.space_id (string)
limit (string)
offset (string)
get_file_linked_account_by_linked_account_idReturns a list of all linked account files and folders associated with the given linked_account_id.linked_account_id (string)
external_folder_id (string)
filetype (string)
limit (string)
name (string)
sort_by (string)
sort_desc (string)
post_file_linked_account_by_linked_account_idUploads 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)
data: {
. external_file_id (string)
} (object) required
post_file_by_file_id_replaceMarks the current file as an replacement for the old file. Only files with type of 'attachment' can be replaced.file_id (string)
data: {
. old_file_id (string)
} (object) required
post_flow_by_ref_type_by_ref_idCreates a new flow on the given reference. Only valid reference is 'app'.ref_type (string)
ref_id (string)
get_flow_by_ref_type_by_ref_idGet all the flows on the given ref.ref_type (string)
ref_id (string)
delete_flow_by_flow_idDelete the flow with the given id.flow_id (string)
get_flow_by_flow_idReturns the flow with the given id.flow_id (string)
put_flow_by_flow_idUpdates the flow. The type cannot be changed.flow_id (string)
data: {
. config (string)
} (object) required
post_flow_by_ref_type_by_ref_id_effect_attributesGet's the effect attributes for the effectref_type (string)
ref_id (string)
get_flow_by_flow_id_contextReturns the possible attributes on the given flow.flow_id (string)
post_flow_by_ref_type_by_ref_id_attributesGet's the possible attributes to use as variables for a given effect attribute.ref_type (string)
ref_id (string)
post_form_by_form_id_activateEnables 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)
post_form_app_by_app_idCreates a new form on the app.app_id (string)
data: {
. css (string)
} (object) required
get_form_app_by_app_idReturns all the active forms on the given app.app_id (string)
post_form_by_form_id_deactivateDisables 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)
delete_form_by_form_idDeletes the form with the given id.form_id (string)
get_form_by_form_idReturns the form with the given id.form_id (string)
put_form_by_form_idUpdates the form with new settings, domains, fields, etc.form_id (string)
data: {
. css (string)
} (object) required
delete_friend_by_user_idsRemove from friends the users with the given user ids.user_ids (string)
get_grant_by_ref_type_by_ref_id_countReturns the count of grants on the given objectref_type (string)
ref_id (string)
post_grant_by_ref_type_by_ref_idCreate a grant on the given object to the given users.ref_type (string)
ref_id (string)
data: {
. people (string)
. action (string)
. message (string)
} (object) required
get_grant_by_ref_type_by_ref_idReturns the grants on the given objectref_type (string)
ref_id (string)
delete_grant_by_ref_type_by_ref_idRemoves all grants on the object with the given type and id.ref_type (string)
ref_id (string)
get_grant_space_by_space_id_user_by_user_idReturns all the grants for the user on the given space.space_id (string)
user_id (string)
get_grant_by_ref_type_by_ref_id_ownReturn the grant information for the active user, if anyref_type (string)
ref_id (string)
get_grant_org_by_org_id_ownReturns all the grants for the current user on the given organization.org_id (string)
delete_grant_by_ref_type_by_ref_id_by_user_idRemoves the grant from the given user on the given objectref_type (string)
ref_id (string)
user_id (string)
put_grant_by_ref_type_by_ref_id_by_user_idUpdates the grant with a new access level.App sharing updates are not allowed in this API.ref_type (string)
ref_id (string)
user_id (string)
post_hook_by_ref_type_by_ref_idCreate a new hook on the given object. See the area for details.ref_type (string)
ref_id (string)
data: {
. url (string)
. type (string)
} (object) required
get_hook_by_ref_type_by_ref_idReturns the hooks on the object.ref_type (string)
ref_id (string)
delete_hook_by_hook_idDeletes the hook with the given id.hook_id (string)
post_hook_by_hook_id_verify_requestRequest 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)
post_hook_by_hook_id_verify_validateValidates the hook using the code received from the verify call. On successful validation the hook will become active.hook_id (string)
data: {
. code (string)
} (object) required
get_importer_by_file_id_infoReturns the import information about the given file.file_id (string)
post_importer_by_file_id_preview_by_rowReturns a preview for the given rowfile_id (string)
row (string)
post_importer_by_file_id_item_app_by_app_idImports the file into the given app. The mapping value for a field depends on the type of field:file_id (string)
app_id (string)
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_idImports the given file into the space contacts on the given space.file_id (string)
space_id (string)
data: {
. mappings (string)
. field_key (string)
. unique (string)
. column_id (string)
} (object) required
post_integration_by_app_idCreates a new integration on the appapp_id (string)
data: {
. type (string)
. silent (string)
. config (string)
} (object) required
delete_integration_by_app_idDeletes the integration from the given app.app_id (string)
get_integration_by_app_idReturns the integration with the given id.app_id (string)
put_integration_by_app_idUpdates the configuration of the integration. The configuration depends on the type of integration.app_id (string)
data: {
. silent (string)
. config (string)
} (object) required
get_integration_by_app_id_fieldReturns the fields available from the configuration.app_id (string)
put_integration_by_app_id_mappingUpdates the mapping between the fields of the app and the fields available from the integration.app_id (string)
post_item_app_by_app_idAdds a new item to the given app.app_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
post_item_app_by_app_id_deleteDeletes items from a given app based in bulk and removes them from all views. The data can no longer be retrieved.app_id (string)
data: {
. silent (string)
} (object) required
post_item_app_by_app_id_calculatePerforms 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)
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_cloneClones the given item creating a new item with identical values in the same app.item_id (string)
data: {
. silent (string)
} (object) required
get_item_by_item_id_cloneReturn 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)
delete_item_by_item_idDeletes an item and removes it from all views. The item can no longer be retrieved.item_id (string)
hook (string)
silent (string)
get_item_by_item_idReturns the item with the specified id.item_id (string)
mark_as_viewed (string)
put_item_by_item_idUpdate 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)
data: {
. hook (string)
. silent (string)
} (object) required
delete_item_by_item_id_refRemoves the reference from the item if anyitem_id (string)
post_item_app_by_app_id_export_by_exporterCreates a batch for exporting the items. Valid exporters are currently 'xls' and 'xlsx'.app_id (string)
exporter (string)
data: {
. limit (string)
. offset (string)
. view_id (string)
. sort_desc (string)
. filters (string)
} (object) required
post_item_app_by_app_id_filterFilters the items and returns the matching items. Full details of the filtering options available can be found in the 'Views' area.app_id (string)
data: {
. space_id (string)
} (object) required
post_item_app_by_app_id_filter_by_view_idRetrieves the items in the app based on the given viewapp_id (string)
view_id (string)
data: {
. limit (string)
. offset (string)
. remember (string)
. sort_by (string)
. sort_desc (string)
} (object) required
get_item_field_by_field_id_findUsed to find possible items for a given application field. It searches the relevant apps for items matching the given text.field_id (string)
limit (string)
not_item_id (string)
text (string)
get_item_app_by_app_id_valuesUsed 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)
get_item_field_by_field_id_rangeReturns the range for the given field. Only valid for fields of type 'number', 'calculation' and 'money'.field_id (string)
get_app_by_app_id_item_by_app_item_idReturns the full item by its app_item_id, which is a unique ID for items per app.app_id (string)
app_item_id (string)
get_item_app_by_app_id_external_id_by_external_idRetrieve an app item with the given external_id.app_id (string)
external_id (string)
get_item_app_by_app_id_countReturns the number of items on app matching a given saved view or set of filters.app_id (string)
key (string)
view_id (string)
get_item_by_item_id_value_by_field_idReturns the values for a specified field on an itemitem_id (string)
field_id (string)
get_item_by_item_id_value_by_field_or_external_id_v2Return 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)
field_or_external_id (string)
get_item_by_item_id_reference_by_field_id_previewReturns a preview of the item for referencing on the given field.item_id (string)
field_id (string)
get_item_by_item_id_referenceReturns 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)
limit (string)
get_item_by_item_id_revision_by_revisionReturns the data about the specific revision on an itemitem_id (string)
revision (string)
delete_item_by_item_id_revision_by_revisionReverts 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)
revision (string)
get_item_by_item_id_revision_by_revision_from_by_revision_toReturns the difference in fields values between the two revisions.item_id (string)
revision_from (string)
revision_to (string)
get_item_by_item_id_revisionReturns all the revisions that have been made to an item up to a maximum of the last 30 revisions.item_id (string)
get_item_by_item_id_valueReturns all the values for an item, with the additional data provided by the get item operation.item_id (string)
put_item_by_item_id_valueUpdates all the values for an itemitem_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
get_item_by_item_id_value_v2Returns the field values on the given item.item_id (string)
get_item_app_by_app_id_xlsxReturns the items in the Xlsx format.app_id (string)
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_urlGets 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)
get_item_by_item_id_field_by_field_id_recalc_statusReturns the recalc status for the requested calculation field in the item.item_id (string)
field_id (string)
get_item_by_item_id_reference_field_by_field_idReturns all the references to the item from the given fielditem_id (string)
field_id (string)
limit (string)
offset (string)
get_item_field_by_field_id_topReturns the top possible values for the given field. This is currently only valid for fields of type 'app'.field_id (string)
limit (string)
not_item_id (string)
post_item_by_item_id_rearrangeUpdate the item's valuesitem_id (string)
data: {
. values (string)
} (object) required
post_item_by_item_id_revision_by_revision_revert_toReverts the item to the values in the given revision. This will undo any changes made after the given revision.item_id (string)
revision (string)
put_item_by_item_id_participationUpdates the participation status for the active user on the itemitem_id (string)
data: {
. status (string)
} (object) required
put_item_by_item_id_value_by_field_or_external_idUpdate 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)
field_or_external_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
delete_layout_by_app_id_by_badge_relationshipDelete custom badge.app_id (string)
badge|relationship (string)
get_item_by_item_id_badge_by_layout_typeGet badge view of user accessible item:item_id (string)
layout_type (string)
get_layout_by_app_id_by_badge_relationship_defaultReturns the definition of a default badge layoutapp_id (string)
badge|relationship (string)
get_layout_by_app_id_by_badge_typeReturns the definition of badge layoutapp_id (string)
badge_type (string)
post_layout_by_app_id_by_layout_typeUpdate layout definition for an app:app_id (string)
layout_type (string)
get_linked_accountGet all linked accounts for the currently logged in usercapability (string)
provider (string)
get_notification_inbox_new_countReturns the number of unread notifications for the active user.No parameters
get_notification_by_notification_idRetrieves a single notification grouped similarly to the get notifications operation.notification_id (string)
get_notification_settingsReturns the notification settings for the active userNo parameters
put_notification_settingsUpdates the notification settings for the userdata: {
. digest (string)
. bulletin (string)
. reference (string)
. message (string)
. space (string)
. subscription (string)
} (object) required
get_notificationReturns 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_viewedMarks all the users notifications as viewed.No parameters
delete_notification_by_notification_id_viewedMark the notification as unviewed. This will move the notification from the viewed archive to the inbox.notification_id (string)
post_notification_by_notification_id_viewedMark the notification as viewed. This will move the notification from the inbox to the viewed archive.notification_id (string)
delete_notification_by_ref_type_by_ref_id_viewedMarks all notifications on the given object as unviewedref_type (string)
ref_id (string)
post_notification_by_ref_type_by_ref_id_viewedMarks all notifications on the given object as viewedref_type (string)
ref_id (string)
post_notification_by_notification_id_starStar the given notification to move it to the star list.notification_id (string)
delete_notification_by_notification_id_starRemoves the star on the notificationnotification_id (string)
post_orgCreates a new organization.data: {
. name (string)
. logo (string)
} (object) required
get_orgReturns a list of all the organizations and spaces the user is member of.No parameters
post_org_by_org_id_appstoreCreates an app store profile for the organization if it doesn't already exist.org_id (string)
delete_org_by_org_id_appstoreDeletes the organizations app store profileorg_id (string)
get_org_by_org_id_appstoreGets the appstore profile of an organization, if any.org_id (string)
put_org_by_org_id_appstoreUpdates the appstore profile of the organization.org_id (string)
delete_org_by_org_id_member_by_user_id_roleRemoves the role from the given user on the given organization.org_id (string)
user_id (string)
delete_org_by_org_id_member_by_user_idEnds 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)
user_id (string)
get_org_by_org_id_member_by_user_idReturns the member data for the given user in the given organization.org_id (string)
user_id (string)
get_org_admin_orgs_by_emailGet Orgs For which given email is an admin along with free orgs where email is part ofemail (string)
get_org_by_org_id_all_spacesReturns 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)
get_org_by_org_idGets the organization with the given id.org_id (string)
put_org_by_org_idUpdates 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)
data: {
. name (string)
. url_label (string)
. logo (string)
} (object) required
get_org_by_org_id_adminReturns the administrators of the organization.org_id (string)
get_org_urlReturns 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_loginReturns 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)
limit (string)
offset (string)
get_org_by_org_id_memberReturns 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)
limit (string)
member_type (string)
offset (string)
query (string)
sort_by (string)
sort_desc (string)
get_org_shared_by_user_idReturns 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)
get_org_by_org_id_space_url_by_urlReturn 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)
url (string)
get_org_by_org_id_member_by_user_id_space_memberReturns 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)
user_id (string)
get_org_by_org_id_spaceReturns all the spaces for the organization.org_id (string)
get_org_by_org_id_member_searchSearches organization members by nameorg_id (string)
post_question_by_question_idAnswers the question for the given object. The object type can be either 'status' or 'comment'.question_id (string)
data: {
. question_option_id (string)
} (object) required
get_question_by_question_idReturns all the answers for the given question on the given object.question_id (string)
post_question_by_ref_type_by_ref_idCreates a new question on the given object. Supported object types are 'status' and 'comment'.ref_type (string)
ref_id (string)
data: {
. text (string)
. options (string)
} (object) required
post_rating_by_ref_type_by_ref_id_by_rating_typeAdd 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)
ref_id (string)
rating_type (string)
data: {
. value (string)
} (object) required
get_rating_by_ref_type_by_ref_id_by_rating_typeGet the rating average for fivestar and totals for the given rating type on the specified object.ref_type (string)
ref_id (string)
rating_type (string)
delete_rating_by_ref_type_by_ref_id_by_rating_typeRemoves a previous rating of the given type by the user of the specified object.ref_type (string)
ref_id (string)
rating_type (string)
get_rating_by_ref_type_by_ref_idReturns all the ratings for the given object. It will only return the ratings that are enabled for the object.ref_type (string)
ref_id (string)
get_rating_by_ref_type_by_ref_id_like_countGet the number of users who liked the given object.ref_type (string)
ref_id (string)
get_rating_by_ref_type_by_ref_id_by_rating_type_by_user_idReturns the rating value for the given rating type, object and user.ref_type (string)
ref_id (string)
rating_type (string)
user_id (string)
get_rating_by_ref_type_by_ref_id_by_rating_type_selfReturns the active users rating value for the given rating type and object.ref_type (string)
ref_id (string)
rating_type (string)
get_rating_by_ref_type_by_ref_id_liked_byGet a list of profiles of everyone that liked the given object.ref_type (string)
ref_id (string)
limit (string)
put_recurrence_by_ref_type_by_ref_idCreates or updates recurrence on the objectref_type (string)
ref_id (string)
data: {
. name (string)
. config (string)
. days (string)
. repeat_on (string)
. step (string)
. until (string)
} (object) required
delete_recurrence_by_ref_type_by_ref_idDeletes the recurrenceref_type (string)
ref_id (string)
get_recurrence_by_ref_type_by_ref_idReturns the recurrence for the given objectref_type (string)
ref_id (string)
get_reference_by_ref_type_by_ref_id_accessible_by_countReturns the number of other users with access to the given object.ref_type (string)
ref_id (string)
get_reference_by_ref_type_by_ref_idReturns information about the referenceref_type (string)
ref_id (string)
accessor_count (string)
context_id (string)
context_type (string)
get_reference_by_ref_type_by_ref_id_accessible_byReturns 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)
ref_id (string)
limit (string)
offset (string)
get_reference_resolveResolves 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_searchSearch 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_idCreates or updates the reminder on a object. Possible ref_types are:ref_type (string)
ref_id (string)
data: {
. remind_delta (string)
} (object) required
delete_reminder_by_ref_type_by_ref_idDeletes the reminder, if any, on the given objectref_type (string)
ref_id (string)
reminder_id (string)
get_reminder_by_ref_type_by_ref_idReturns the reminder for the given objectref_type (string)
ref_id (string)
post_reminder_by_ref_type_by_ref_id_snoozeSnoozes the reminder for 10 minutesref_type (string)
ref_id (string)
data: {
. reminder_id (string)
} (object) required
get_search_appby_app_id_space_by_space_idSearches in all items, files, and tasks in the app and space.app_id (string)
space_id (string)
post_searchSearches 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_v2Searches 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_idSearches in all items and tasks in the app.app_id (string)
data: {
. search_fields (string)
} (object) required
get_search_app_by_app_id_v2Searches 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)
counts (string)
highlights (string)
limit (string)
offset (string)
query (string)
ref_type (string)
search_fields (string)
post_search_org_by_org_idSearches in all items, statuses and non-private tasks in the organization.org_id (string)
data: {
. search_fields (string)
} (object) required
get_search_org_by_org_id_v2Searches 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)
counts (string)
highlights (string)
limit (string)
offset (string)
query (string)
ref_type (string)
search_fields (string)
post_search_space_by_space_idSearches 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)
data: {
. search_fields (string)
} (object) required
get_search_space_by_space_id_v2Searches 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)
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_acceptAccept a request from another user to be added to the space.space_id (string)
space_member_request_id (string)
post_space_by_space_id_memberAdds 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)
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_memberReturns the active members of the given space.space_id (string)
delete_space_by_space_id_member_by_user_idsEnds all the users membership on the space, can also be called for members in state invited.space_id (string)
user_ids (string)
put_space_by_space_id_member_by_user_idsUpdates the space memberships with another rolespace_id (string)
user_ids (string)
data: {
. role (string)
} (object) required
get_space_by_space_id_member_totalReturns the total number of internal and external space members on the spacespace_id (string)
get_space_by_space_id_member_by_user_id_v2Returns the membership details for the given user on the given space.space_id (string)
user_id (string)
get_space_by_space_id_member_by_roleReturns the space members with the specified role.space_id (string)
role (string)
get_space_by_space_id_member_v2Returns the members of the given spacespace_id (string)
limit (string)
member_type (string)
offset (string)
query (string)
get_space_by_space_id_member_by_user_idUsed to get the details of an active users membership of a space.space_id (string)
user_id (string)
post_space_by_space_id_joinJoins the open space with the given idspace_id (string)
post_space_by_space_id_member_requestRequest 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)
post_space_by_space_id_archiveArchives the workspace. This hides it from navigation, but doesn't do anything other than that.space_id (string)
post_spaceAdd 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_idDeletes 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)
get_space_by_space_idGet the space with the given idspace_id (string)
put_space_by_space_idUpdates the space with the given idspace_id (string)
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_availableReturns the available seats. A null value means there is an unlimited number of available seats.space_id (string)
get_space_org_by_org_id_availableReturns the available spaces for the given organization. This is spaces that are open and available for the user to join.org_id (string)
get_space_org_by_org_idReturns the workspaces in the organization that are accesible for the active user.org_id (string)
get_space_org_by_org_id_url_by_url_labelReturns the space in the given org with the given URL labelorg_id (string)
url_label (string)
get_space_urlReturns the space and organization with the given full URL.org_slug (string)
space_slug (string)
url (string)
get_space_topReturns the top spaces for the userlimit (string)
post_space_by_space_id_restoreRestores an archived workspace. This unhides it from navigation, but doesn't do anything other than that.space_id (string)
post_status_space_by_space_idCreates 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)
data: {
. alert_invite (string)
} (object) required
delete_status_by_status_idThis 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)
get_status_by_status_idRetrieves a status message by its id. The id of the status message is usually gotten from the stream.status_id (string)
put_status_by_status_idThis will update an existing status message. This will normally only be used to correct spelling and grammatical mistakes.status_id (string)
data: {
. file_ids (array)
. embed_id (string)
. embed_url (string)
} (object) required
post_stream_app_by_app_id_filterReturns the stream for the given app filtered using the item filters.app_id (string)
get_stream_app_by_app_idReturns the stream for the given app. This includes items from the app and tasks on the app.app_id (string)
limit (string)
offset (string)
get_stream_app_by_app_id_v3Get stream for an applicationapp_id (string)
groups_event_types (string)
groups_limit (string)
limit (string)
offset (string)
get_streamReturns 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_v3Get global stream - version 3groups_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_idReturn the activity group for the given ref and data refref_type (string)
ref_id (string)
data_ref_type (string)
data_ref_id (string)
event_types (string)
get_stream_by_ref_type_by_ref_id_group_by_event_idReturn group in which event with event_id is inref_type (string)
ref_id (string)
event_id (string)
event_types (string)
get_stream_by_ref_type_by_ref_id_activity_groupGet grouped events for the given reference. The groups are returned in descending order, with the most recent group in the top.ref_type (string)
ref_id (string)
event_types (string)
from_groupd_id (string)
limit (string)
offset (string)
to_group_id (string)
get_stream_org_by_org_id_v3Get stream for an organization - version 3org_id (string)
groups_event_types (string)
groups_limit (string)
limit (string)
offset (string)
get_stream_org_by_org_idReturns the activity stream for the given organization.org_id (string)
limit (string)
offset (string)
get_stream_space_by_space_idReturns the activity stream for the space.space_id (string)
limit (string)
offset (string)
get_stream_space_by_space_id_v3Get stream for a space - version 3space_id (string)
groups_event_types (string)
groups_limit (string)
get_stream_by_ref_type_by_ref_idReturns 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)
ref_id (string)
get_stream_by_ref_type_by_ref_id_v3Get stream view of an object - version 3ref_type (string)
ref_id (string)
groups_event_types (string)
groups_limit (string)
get_stream_user_by_user_idReturns 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)
limit (string)
offset (string)
get_stream_user_by_user_id_v3Get stream for an user - version 3user_id (string)
groups_event_types (string)
groups_limit (string)
limit (string)
offset (string)
get_subscription_inactiveReturns the subscriptions to spaces and apps, where the user have not been active recently.No parameters
get_subscription_by_subscription_idReturns the subscription with the given idsubscription_id (string)
delete_subscription_by_subscription_idStops the subscription with the given idsubscription_id (string)
get_subscription_by_ref_type_by_ref_idGet the subscription for the given objectref_type (string)
ref_id (string)
post_subscription_by_ref_type_by_ref_idSubscribes 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)
ref_id (string)
delete_subscription_by_ref_type_by_ref_idUnsubscribe from getting notifications on actions on the given object.ref_type (string)
ref_id (string)
post_tag_by_ref_type_by_ref_idAdds 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)
ref_id (string)
delete_tag_by_ref_type_by_ref_idRemoves a single tag from an object.ref_type (string)
ref_id (string)
text (string)
put_tag_by_ref_type_by_ref_idUpdates 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)
ref_id (string)
get_tag_app_by_app_id_search_fullYou can simulate the API request by filling out the arguments below, and press the submit button to see the response.app_id (string)
get_tag_app_by_app_id_searchReturns 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)
text (string)
get_tag_org_by_org_id_searchReturns 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)
text (string)
get_tag_space_by_space_id_searchReturns 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)
text (string)
get_tag_app_by_app_idReturns 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)
limit (string)
text (string)
get_tag_app_by_app_id_topReturns the top tags on the app.app_id (string)
limit (string)
text (string)
get_tag_org_by_org_idReturns 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)
limit (string)
text (string)
get_tag_space_by_space_idReturns 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)
limit (string)
text (string)
post_task_by_task_id_assignAssigns the task to another user. This makes the user responsible for the task and its completion.task_id (string)
data: {
. silent (string)
} (object) required
post_task_by_task_id_completeMark the given task as completed.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
post_task_labelCreates a new personal label for the user.data: {
. text (string)
. color (string)
} (object) required
get_task_labelReturns the users task labels.No parameters
post_taskCreates a new task.data: {
. hook (string)
. silent (string)
} (object) required
get_taskReturns 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_idCreates 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)
ref_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
get_task_by_ref_type_by_ref_idGets 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)
ref_id (string)
delete_task_label_by_label_idDeletes the label with the given id. This will remove the label from all tasks.label_id (string)
put_task_label_by_label_idUpdates the label with the given idlabel_id (string)
data: {
. text (string)
. color (string)
} (object) required
delete_task_by_task_idDeletes the task with the given id.task_id (string)
hook (string)
silent (string)
get_task_by_task_idReturns the task with the given id.task_id (string)
put_task_by_task_idUpdates the task with the given attributes. Any attributes not specified will remain unchanged.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
get_task_by_ref_type_by_ref_id_countReturns the total open tasks for the user on the reference.ref_type (string)
ref_id (string)
get_task_summaryReturns the task summary for the active userlimit (string)
get_task_org_by_org_id_summaryReturns the task summary for the organization for the active userorg_id (string)
limit (string)
get_task_personal_summaryReturns the tasks summary for personal tasks and tasks on personal spaces and sub-orgs.limit (string)
get_task_by_ref_type_by_ref_id_summaryReturns the task summary for the given object.ref_type (string)
ref_id (string)
limit (string)
get_task_space_by_space_id_summaryReturns the task summary for the given space for the active userspace_id (string)
limit (string)
get_task_total_by_timeReturns the total number of tasks for the given time. The valid values for time are: 'overdue', 'due', 'today' and 'all'time (string)
space_id (string)
get_task_totalGet the totals for the users active tasks.space (string)
post_task_by_task_id_incompleteMark the completed task as no longer being completed.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
post_task_by_task_id_rankRanks the task in comparision to one or two other tasks.task_id (string)
data: {
. after (string)
. before (string)
} (object) required
delete_task_by_task_id_refDeletes the reference on the tasktask_id (string)
put_task_by_task_id_refAttached 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)
data: {
. hook (string)
. silent (string)
} (object) required
put_task_by_task_id_descriptionUpdates the description of the task.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
put_task_by_task_id_dueUpdates the due on property on the tasktask_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
put_task_by_task_id_labelUpdates the task with new labelstask_id (string)
put_task_by_task_id_privateUpdate the private flag on the given task.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
put_task_by_task_id_textUpdates the text of the task.task_id (string)
data: {
. hook (string)
. silent (string)
} (object) required
delete_user_property_by_nameDeletes the property for the active user with the given name. The property is specific to the auth client used.name (string)
get_user_property_by_nameReturns the value of the property for the active user with the given name. The property is specific to the auth client used.name (string)
put_user_property_by_nameSets the value of the property for the active user with the given name. The property is specific to the auth client used.name (string)
get_user_setting_by_client_type_by_notification_typeGet's the setting for the given client type and notification type.client_type (string)
notification_type (string)
put_user_setting_by_client_type_by_notification_typeUpdates the setting for the given client type and notification type.client_type (string)
notification_type (string)
data: {
. value (string)
} (object) required
get_user_setting_by_client_typeGet's the setting for the given client typeclient_type (string)
put_user_setting_by_client_typeUpdates the setting for the given client typeclient_type (string)
get_user_profileReturns the profile of the active userNo parameters
put_user_profileUpdates 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_keyReturns 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)
put_user_profile_by_keyUpdates the specific field on the userkey (string)
data: {
. value (string)
} (object) required
get_userGets the active user.No parameters
get_user_statusReturns the current status for the user. This includes the user data, profile data and notification data.No parameters
put_user_propertySets 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_idCreates a new view on the given app.app_id (string)
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_idReturns the views on the given app.app_id (string)
include_standard_views (string)
delete_view_by_view_idDeletes the given viewview_id (string)
put_view_by_view_idUpdates the given viewview_id (string)
get_view_app_by_app_id_by_view_id_or_nameReturns 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)
view_id_or_name (string)
post_view_by_view_id_defaultMakes 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)
put_view_app_by_app_id_lastUpdates the last view for the active userapp_id (string)
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_votingUpdate app voting with new voting's provided in body.app_id (string)
post_voting_app_by_app_id_votingCreate voting of kind specified in request body to applicationapp_id (string)
get_voting_app_by_app_id_votingResturn application Votings in user-defined order.app_id (string)
put_voting_by_voting_id_answer_orderChange order of answers presentation in possible voting.voting_id (string)
put_voting_app_by_app_id_voting_orderSet voting order in scope of applicationapp_id (string)
post_voting_by_voting_id_answersCreate answer in application voting.voting_id (string)
delete_voting_answer_by_answer_idDelete Answer in Votinganswer_id (string)
put_voting_answer_by_answer_idChanges text of Answer in Votinganswer_id (string)
delete_voting_by_voting_idDelete specified Votingvoting_id (string)
get_voting_by_voting_idReturn one voting objectvoting_id (string)
put_voting_by_voting_idUpdate voting question with question specified in POST in Voting.voting_id (string)
get_voting_item_by_item_id_voting_by_voting_id_userReturn profiles of user that has voted in specified way by parameter value.item_id (string)
voting_id (string)
value (string)
get_voting_item_by_item_id_voting_by_voting_id_resultGet result of voting on an item.item_id (string)
voting_id (string)
max_voters (string)
get_voting_item_by_item_id_resultGet result of voting on an item.item_id (string)
max_voters (string)
delete_voting_item_by_item_id_voting_by_voting_id_votesDelete user vote on an item in concrete voting objectitem_id (string)
voting_id (string)
post_voting_item_by_item_id_voting_by_voting_id_votesVote on an item - rating votingitem_id (string)
voting_id (string)
post_widget_by_widget_id_cloneClones the widget to a new position. The widget will be placed at the bottom of existing widgets.widget_id (string)
post_widget_by_ref_type_by_ref_idCreate 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)
ref_id (string)
data: {
. type (string)
. title (string)
. config (string)
} (object) required
get_widget_by_ref_type_by_ref_idReturns the widgets on the given reference for display. This includes the current data to be shown in the widgets.ref_type (string)
ref_id (string)
delete_widget_by_widget_idDeletes the given widget.widget_id (string)
get_widget_by_widget_idReturns the widget with the given id.widget_id (string)
put_widget_by_widget_idUpdates a widget with a new title and configuration.widget_id (string)
data: {
. title (string)
. config (string)
} (object) required
put_widget_by_ref_type_by_ref_id_orderUpdates the order of the widgets on a reference. The ids of the widgets should be put in the new requested order.ref_type (string)
ref_id (string)