# Percolate Documentation

> Documentation for Percolate

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Authorization & Authentication](https://percolate.dev/docs/authorization-authentication-quickstart.md)
- [Integration Patterns](https://percolate.dev/docs/integration-patterns.md)
- [Intro to the Object Model](https://percolate.dev/docs/introduction-to-the-percolate-object-model.md)
- [Defining an App](https://percolate.dev/docs/defining-an-app.md)
- [Giving an App Access to Data](https://percolate.dev/docs/capabilities.md): Percolate capabilities drive which endpoints and data an app is authorized to access. To enable such access, capabilities must be defined under the App manifest’s [capabilities](#) field.
- [Installing and Managing Apps](https://percolate.dev/docs/installing-and-managing-pdp-apps.md)
- [Running an App Server](https://percolate.dev/docs/running-an-app-server.md)
- [Sample Apps](https://percolate.dev/docs/sample-apps.md)
- [Webhooks Guide](https://percolate.dev/docs/webhooks-quickstart.md)
- [Mutual TLS](https://percolate.dev/docs/mutual-tls.md)
- [Webhook Event Schema](https://percolate.dev/docs/webhook-event-schema.md)

## API Reference
- [Introduction](https://percolate.dev/reference/introduction.md)
- [Responses](https://percolate.dev/reference/responses.md)
- [References](https://percolate.dev/reference/references.md)
- [Preview](https://percolate.dev/reference/preview.md)
- [Rate Limits](https://percolate.dev/reference/rate-limits.md)
- [Pagination](https://percolate.dev/reference/pagination.md)
- [Batching](https://percolate.dev/reference/batching.md)
- [Color By](https://percolate.dev/reference/color-by.md)
- [Group By](https://percolate.dev/reference/group-by.md)
- [/api/v5/access/](https://percolate.dev/reference/getaccess.md): Get a list of access records.
- [/api/v5/access/](https://percolate.dev/reference/createaccess.md): Create new access records.
- [/api/v5/access/{access_id}](https://percolate.dev/reference/getaccessbyid.md): Retrieve an access record.
- [/api/v5/access/{access_id}](https://percolate.dev/reference/updateaccess.md): Edit an access.
- [/api/v5/access/{access_id}](https://percolate.dev/reference/deleteaccess.md): Delete an access.
- [/api/v5/approval/](https://percolate.dev/reference/getapprovals.md): Get a list of approvals.
- [/api/v5/approval/](https://percolate.dev/reference/createapproval.md): Create an approval.
- [/api/v5/approval/{approval_id}](https://percolate.dev/reference/getapprovalbyid.md): Get a single approval by ID.
- [/api/v5/approval/{approval_id}](https://percolate.dev/reference/updateapproval.md): Update and return a approval.
- [/api/v5/approval/{approval_id}](https://percolate.dev/reference/deleteapproval.md): Delete a approval.
- [/api/v5/approval/{approval_id}/vote](https://percolate.dev/reference/approvalvote.md): An action endpoint for voting on an approval step.
- [/api/v5/approval_template/](https://percolate.dev/reference/getapprovaltemplate.md): Get a list of approval_templates by ids.
- [/api/v5/approval_template/](https://percolate.dev/reference/createapprovaltemplate.md): Create a approval_template.
- [/api/v5/approval_template/{approval_template_id}](https://percolate.dev/reference/getapprovaltemplatebyid.md): Get a single approval_template by ID.
- [/api/v5/approval_template/{approval_template_id}](https://percolate.dev/reference/updateapprovaltemplate.md): Update and return a approval_template.
- [/api/v5/approval_template/{approval_template_id}](https://percolate.dev/reference/deleteapprovaltemplate.md): Delete a approval_template.
- [/api/v5/asset/](https://percolate.dev/reference/getassets.md): Get a list of assets by ids.
- [/api/v5/asset/](https://percolate.dev/reference/createasset.md): A new asset will be created that duplicates the referenced source asset.  All basic metadata (e.g. name) will be copied but comments, followers, etc. will *not* be replicated.
- [/api/v5/asset/{asset_id}](https://percolate.dev/reference/getassetbyid.md): Get a single asset by ID.
- [/api/v5/asset/{asset_id}](https://percolate.dev/reference/updateasset.md): Move, rename, restore, or rollback an asset.
- [/api/v5/asset/{asset_id}](https://percolate.dev/reference/deleteasset.md): Delete a asset.
- [/api/v5/asset/{asset_id}/download](https://percolate.dev/reference/assetdownload.md): Download an asset’s file data. It is crucial that all redirects returned from this call are followed as the response will be a 303. In addition, URLs returned from redirects must not be cached, they will have a short TTL.
- [/api/v5/variant/](https://percolate.dev/reference/getvariants.md): Get a list of variants.
- [/api/v5/variant/{variant_id}](https://percolate.dev/reference/getvariantbyid.md): Get a single Variant by ID.
- [/api/v5/variant/{variant_id}/download](https://percolate.dev/reference/downloadvariant.md): Download a variant’s file data.  It is crucial that all redirects returned from this call are followed as the response will be a 303.  In addition, URLs returned from redirects must not be cached, they will have a short TTL.
- [/auth/v5/token/](https://percolate.dev/reference/createaccesstoken.md): The access token request must be authenticated utilizing the "HTTP Basic authentication scheme" as defined in [RFC 2617](http://tools.ietf.org/html/rfc2617#section-2). This endpoint supports both standard submission using `application/x-www-form-urlencoded` and `application/json` content types for convenience. Your Client ID and Client Secret must be joined by ":", then Base64 encoded, and included in the `Authorization` request header (ex. `base64("{client_id}:{client_secret}")`). For example, for a Client ID "client:9001" and Secret "thesystemofrecord", the following header would be expected once Base64 encoded (i.e. `base64("client:9001:thesystemofrecord")``):      Authorization: Basic Y2xpZW50OjkwMDE6dGhlc3lzdGVtb2ZyZWNvcmQ=  If authenticating via Postman, you would choose "Basic Auth" as the Auth Type, the Client ID (e.g. "client:9001") as the username, and the Client Secret as the password (e.g. "thesystemofrecord"). Postman handles the Base64 encoding for you.
- [/api/v5/campaign/](https://percolate.dev/reference/getcampaigns.md): Get a list of campaigns by ids.
- [/api/v5/campaign/](https://percolate.dev/reference/createcampaign.md): Create a campaign.
- [/api/v5/campaign/{campaign_id}](https://percolate.dev/reference/getcampaignbyid.md): Get a single campaign by ID.
- [/api/v5/campaign/{campaign_id}](https://percolate.dev/reference/updatecampaign.md): Update and return a campaign.
- [/api/v5/campaign/{campaign_id}](https://percolate.dev/reference/deletecampaign.md): Delete a campaign.
- [/api/v5/campaign_section/](https://percolate.dev/reference/getcampaignsectionnodes.md): Get a list of campaign_sections.
- [/api/v5/campaign_section/](https://percolate.dev/reference/createcampaignsection.md): Create a campaign_section.
- [/api/v5/campaign_section/{campaign_section_id}](https://percolate.dev/reference/getcampaignsectionbyid.md): Get a single campaign_section by ID.
- [/api/v5/campaign_section/{campaign_section_id}](https://percolate.dev/reference/updatecampaignsection.md): Update and return a campaign_section.
- [/api/v5/campaign_section/{campaign_section_id}](https://percolate.dev/reference/deletecampaignsection.md): Delete a campaign_section.
- [/api/v5/campaign_template/](https://percolate.dev/reference/getcampaigntemplates.md): Get a list of campaign_templates by ids.
- [/api/v5/campaign_template/](https://percolate.dev/reference/createcampaigntemplate.md): Create a campaign_template.
- [/api/v5/campaign_template/{campaign_template_id}](https://percolate.dev/reference/getcampaigntemplatebyid.md): Get a single campaign_template by ID.
- [/api/v5/campaign_template/{campaign_template_id}](https://percolate.dev/reference/updatecampaigntemplate.md): Update and return a campaign_template.
- [/api/v5/campaign_template/{campaign_template_id}](https://percolate.dev/reference/deletecampaigntemplate.md): Delete a campaign_template.
- [/api/v5/campaign_template_node/](https://percolate.dev/reference/getcampaigntemplatenodes.md): Get a list of campaign_template_nodes.
- [/api/v5/campaign_template_node/](https://percolate.dev/reference/createcampaigntemplatenode.md): Create a campaign_template_node.
- [/api/v5/campaign_template_node/{campaign_template_node_id}](https://percolate.dev/reference/getcampaigntemplatenodebyid.md): Get a single campaign_template_node by ID.
- [/api/v5/campaign_template_node/{campaign_template_node_id}](https://percolate.dev/reference/updatecampaigntemplatenode.md): Update and return a campaign_template_node.
- [/api/v5/campaign_template_node/{campaign_template_node_id}](https://percolate.dev/reference/deletecampaigntemplatenode.md): Delete a campaign_template_node.
- [/api/v5/campaign_template_node/{campaign_template_node_id}/apply/](https://percolate.dev/reference/applycampaigntemplatenode.md): Creates an integrated campaign hierarchy from a campaign template tree. The response includes the root campaign. The rest of the hierarchy is created asynchronosouly.
- [/api/v5/channel/](https://percolate.dev/reference/getchannels.md): Get a list of channels by ids.
- [/api/v5/channel/](https://percolate.dev/reference/createchannel.md): Create a channel.
- [/api/v5/channel/{channel_id}](https://percolate.dev/reference/getchannelbyid.md): Get a single channel by ID.
- [/api/v5/channel/{channel_id}](https://percolate.dev/reference/updatechannel.md): Update and return a channel.
- [/api/v5/comment/](https://percolate.dev/reference/getcomments.md): Get a list of comments.
- [/api/v5/comment/](https://percolate.dev/reference/createcomment.md): Create a comment.
- [/api/v5/comment/{comment_id}](https://percolate.dev/reference/getcommentbyid.md): Get a single comment by ID.
- [/api/v5/comment/{comment_id}](https://percolate.dev/reference/updatecomment.md): Update and return a comment.
- [/api/v5/comment/{comment_id}](https://percolate.dev/reference/deletecomment.md): Delete a comment.
- [/api/v5/comment/{comment_id}/resolve](https://percolate.dev/reference/resolvecomment.md): Resolve / unresolve a comment. Currently limited to comments of type `inline`.
- [/api/v5/export/](https://percolate.dev/reference/getexports.md): Get a subset of the data as JSON for preview purposes.
- [/api/v5/export/](https://percolate.dev/reference/createexport.md): Requesting the full set triggers an async job that emails a link to download a CSV to the current user. Note: the order of `fields` is preserved in CSV.
- [/api/v5/folder/](https://percolate.dev/reference/getfolders.md): Get a list of folders.
- [/api/v5/folder/](https://percolate.dev/reference/createfolder.md): Create a folder.
- [/api/v5/folder/{folder_id}](https://percolate.dev/reference/getfolderbyid.md): Get a single folder by ID.
- [/api/v5/folder/{folder_id}](https://percolate.dev/reference/updatefolder.md): Update, move, or restore a folder.
- [/api/v5/folder/{folder_id}](https://percolate.dev/reference/deletefolder.md): Delete a folder.
- [/api/v5/me](https://percolate.dev/reference/getcurrentuser.md): Get current user.
- [/api/v5/object_step/](https://percolate.dev/reference/getobjectsteps.md): Get a list of object_steps by ids.
- [/api/v5/object_step/batch_update/](https://percolate.dev/reference/batchupdateobjectstep.md): Batch update object steps
- [/api/v5/intake_request/](https://percolate.dev/reference/getintakerequests.md): Get a list of intake_requests.
- [/api/v5/intake_request/](https://percolate.dev/reference/createintakerequest.md): Create a intake_request.
- [/api/v5/intake_request/{intake_request_id}](https://percolate.dev/reference/getintakerequestbyid.md): Get a single intake_request by ID.
- [/api/v5/intake_request/{intake_request_id}](https://percolate.dev/reference/updateintakerequest.md): Update and return a intake_request.
- [/api/v5/intake_request/{intake_request_id}](https://percolate.dev/reference/deleteintakerequest.md): Delete a intake_request.
- [/api/v5/license/](https://percolate.dev/reference/getlicenses.md): Get a list of licenses.
- [/api/v5/license/](https://percolate.dev/reference/createlicense.md): Create a license.
- [/api/v5/license/{license_id}](https://percolate.dev/reference/getlicensebyid.md): Get a single license by ID.
- [/api/v5/license/{license_id}](https://percolate.dev/reference/updatelicense.md): Update and return a license.
- [/api/v5/license/{license_id}](https://percolate.dev/reference/deletelicense.md): Delete a license.
- [/api/v5/metadata/](https://percolate.dev/reference/getmetadatas.md): Get a list metadata objects.
- [/api/v5/metadata/](https://percolate.dev/reference/createmetadata.md): Create a metadata object.
- [/api/v5/metadata/{metadata_id}](https://percolate.dev/reference/getmetadatabyid.md): Get a single metadata by ID.
- [/api/v5/metadata/{metadata_id}](https://percolate.dev/reference/updatemetadata.md): Update and return a metadata object.
- [/api/v5/metadata/{metadata_id}](https://percolate.dev/reference/deletemetadata.md): Delete a metadata.
- [/api/v5/platform/](https://percolate.dev/reference/getplatforms.md): List platforms.
- [/api/v5/platform/](https://percolate.dev/reference/createplatform.md): Create a platform.
- [/api/v5/platform/{platform_id}](https://percolate.dev/reference/getplatformbyid.md): Get a Platform by UID.
- [/api/v5/platform/{platform_id}](https://percolate.dev/reference/updateplatform.md): Update and return a platform.
- [/api/v5/postwebhook/](https://percolate.dev/reference/getpostwebhooks.md): List post webhooks.
- [/api/v5/postwebhook/](https://percolate.dev/reference/createpostwebhook.md): Create a post webhook association.
- [/api/v5/postwebhook/{postwebhook_id}](https://percolate.dev/reference/deletepostwebhook.md): Delete a post webhook association.
- [/api/v5/post/](https://percolate.dev/reference/getposts.md): List posts.
- [/api/v5/post/](https://percolate.dev/reference/createpost.md): Create a post.
- [/api/v5/post/{post_id}](https://percolate.dev/reference/getpostbyid.md): Get a single post by ID.
- [/api/v5/post/{post_id}](https://percolate.dev/reference/updatepost.md): Update and return a post.
- [/api/v5/post/{post_id}](https://percolate.dev/reference/deletepost.md): Delete a post.
- [/api/v5/post_attachment/](https://percolate.dev/reference/getpostattachments.md): List post_attachments.
- [/api/v5/post_attachment/](https://percolate.dev/reference/createpostattachment.md): Create a post_attachment.
- [/api/v5/post_attachment/{post_attachment_id}](https://percolate.dev/reference/getpostattachmentbyid.md): Get a single post_attachment by ID.
- [/api/v5/post_attachment/{post_attachment_id}](https://percolate.dev/reference/updatepostattachment.md): Update and return a post_attachment.
- [/api/v5/production_workflow/](https://percolate.dev/reference/getproductionworkflows.md): Get a list of production_workflows by ids.
- [/api/v5/production_workflow/](https://percolate.dev/reference/createproductionworkflow.md): Create a production_workflow.
- [/api/v5/production_workflow/{production_workflow_id}](https://percolate.dev/reference/getproductionworkflowbyid.md): Get a single production_workflow by ID.
- [/api/v5/production_workflow/{production_workflow_id}](https://percolate.dev/reference/updateproductionworkflow.md): Update and return a production_workflow.
- [/api/v5/production_workflow/{production_workflow_id}](https://percolate.dev/reference/deleteproductionworkflow.md): Delete a production_workflow.
- [/api/v5/production_workflow_transition/](https://percolate.dev/reference/createproductionworkflowtransition.md): Transition from one object step to another.
- [/api/v5/role/](https://percolate.dev/reference/getroles.md): List roles for given scope ids.
- [/api/v5/role/](https://percolate.dev/reference/createrole.md): Create a role.
- [/api/v5/role/{role_id}](https://percolate.dev/reference/getrolebyid.md): Get a Role by UID.
- [/api/v5/role/{role_id}](https://percolate.dev/reference/updaterole.md): Update and return a role.
- [/api/v5/role/{role_id}](https://percolate.dev/reference/deleterole.md): Delete a role.
- [/api/v5/schema/](https://percolate.dev/reference/getschemas.md): Get a list of schemas by ids.
- [/api/v5/schema/](https://percolate.dev/reference/createschema.md): Create a schema.
- [/api/v5/schema/{schema_id}](https://percolate.dev/reference/getschemabyid.md): Get a single schema by ID.
- [/api/v5/schema/{schema_id}](https://percolate.dev/reference/updateschema.md): Update and return a schema.
- [/api/v5/task/](https://percolate.dev/reference/gettasks.md): Get a list of tasks.
- [/api/v5/task/](https://percolate.dev/reference/createtask.md): Create a task.
- [/api/v5/task/{task_id}](https://percolate.dev/reference/gettaskbyid.md): Get a single task by ID.
- [/api/v5/task/{task_id}](https://percolate.dev/reference/updatetask.md): Update and return a task.
- [/api/v5/task/{task_id}](https://percolate.dev/reference/deletetask.md): Delete a task.
- [/api/v5/task/apply_task_template/](https://percolate.dev/reference/applytasktemplate.md): Creates a list of tasks from a specific template.
- [/api/v5/task_template/](https://percolate.dev/reference/gettasktemplates.md): Get a list of task templates.
- [/api/v5/task_template/](https://percolate.dev/reference/createtasktemplate.md): Create a task_template.
- [/api/v5/task_template/{task_template_id}](https://percolate.dev/reference/gettasktemplatebyid.md): Get a single task_template by ID.
- [/api/v5/task_template/{task_template_id}](https://percolate.dev/reference/updatetasktemplate.md): Update and return a task_template.
- [/api/v5/task_template/{task_template_id}](https://percolate.dev/reference/deletetasktemplate.md): Delete a task_template.
- [/api/v5/taxonomy/](https://percolate.dev/reference/gettaxonomys.md): Get a list of taxonomys.
- [/api/v5/taxonomy/](https://percolate.dev/reference/createtaxonomy.md): Create a taxonomy.
- [/api/v5/taxonomy/{taxonomy_id}](https://percolate.dev/reference/gettaxonomybyid.md): Get a single taxonomy by ID.
- [/api/v5/taxonomy/{taxonomy_id}](https://percolate.dev/reference/updatetaxonomy.md): Update and return a taxonomy.
- [/api/v5/taxonomy/{taxonomy_id}](https://percolate.dev/reference/deletetaxonomy.md): Delete a taxonomy.
- [/api/v5/tenant/](https://percolate.dev/reference/gettenants.md): Returns all available tenants a user has access to even if their access token is bound to a single tenant.
- [/api/v5/tenant/](https://percolate.dev/reference/createtenant.md): Create a tenant
- [/api/v5/tenant/{tenant_id}](https://percolate.dev/reference/gettenantbyid.md): Get a tenant by UID.
- [/api/v5/tenant/{tenant_id}](https://percolate.dev/reference/updatetenant.md): Update and return a tenant.
- [/api/v5/term/](https://percolate.dev/reference/getterms.md): Retrieve a list of terms. Required values: either of (ids | scope_ids | parent_ids). Optional values: depth & search.
- [/api/v5/term/](https://percolate.dev/reference/createterm.md): Create a term.
- [/api/v5/term/{term_id}](https://percolate.dev/reference/gettermbyid.md): Get a single term by ID.
- [/api/v5/term/{term_id}](https://percolate.dev/reference/updateterm.md): Update and return a term.
- [/api/v5/term/{term_id}](https://percolate.dev/reference/deleteterm.md): Delete a term.
- [/api/v5/uix_visibility/](https://percolate.dev/reference/getuixvisibility.md): Retrieve UI Extension Visibility Criteria for an App Installation
- [/api/v5/uix_visibility/](https://percolate.dev/reference/setuixvisibility.md): Set/Overwrite uix_visibility for an app_installation
- [/api/v5/uix_visibility/{app_installation_id}](https://percolate.dev/reference/getuixvisibilitybyappinstallationid.md): (Deprecated) Retrieve UI Extension Visibility Criteria for an App Installation
- [/api/v5/uix_visibility/{app_installation_id}](https://percolate.dev/reference/setuixvisibilitybyappinstallationid.md): (Deprecated) Set/Overwrite uix_visibility for an app_installation
- [/api/v5/upload/](https://percolate.dev/reference/createupload.md): Create an upload.
- [/api/v5/upload/{upload_id}](https://percolate.dev/reference/getuploadbyid.md): Get a single upload by ID.
- [/api/v5/upload/{upload_id}](https://percolate.dev/reference/updateupload.md): Update and return a upload.
- [/api/v5/upload_policy/](https://percolate.dev/reference/createuploadpolicy.md): Create an upload_policy.
- [/api/v5/user/](https://percolate.dev/reference/getusers.md): Get a list of users.
- [/api/v5/user/](https://percolate.dev/reference/createuser.md): Create a user.
- [/api/v5/user/{user_id}](https://percolate.dev/reference/getuserbyid.md): Get a single user by ID.
- [/api/v5/user/{user_id}](https://percolate.dev/reference/updateuser.md): Update and return a user.
- [/api/v5/user/{user_id}/password](https://percolate.dev/reference/updatepassword.md): Change user password.
- [/api/v5/user/password](https://percolate.dev/reference/resetpassword.md): Email the user a password reset email. Available to unauthenticated users. Heavily rate-limited.
- [/api/v5/user_role/](https://percolate.dev/reference/getuserroles.md): Get a list of user_roles.
- [/api/v5/user_role/](https://percolate.dev/reference/createuserrole.md): Create a user_role.
- [/api/v5/user_role/{user_role_id}](https://percolate.dev/reference/getuserrolebyid.md): Get a single user_role by ID.
- [/api/v5/user_role/{user_role_id}](https://percolate.dev/reference/deleteuserrole.md): Delete a user_role.
- [/api/v5/user_role_import/](https://percolate.dev/reference/createuserroleimport.md): Import user roles from uploaded asset identified by the asset ID.
- [/api/v5/webhook_subscription/](https://percolate.dev/reference/getwebhooksubscriptions.md): Get a list of webhook subscriptions (Preview).
- [/api/v5/webhook_subscription/](https://percolate.dev/reference/createwebhooksubscription.md): Create a webhook subscription (Preview).
- [/api/v5/webhook_subscription/{webhook_subscription_id}](https://percolate.dev/reference/getwebhooksubscriptionbyid.md): Get a single webhook subscription (Preview).
- [/api/v5/webhook_subscription/{webhook_subscription_id}](https://percolate.dev/reference/updatewebhooksubscription.md): Update a webhook subscription (Preview).
- [/api/v5/webhook_subscription/{webhook_subscription_id}](https://percolate.dev/reference/deletewebhooksubscription.md): Delete a webhook_subscription.
- [/api/v5/webhook_log/](https://percolate.dev/reference/getwebhooklogs.md): Get a list of event delivery logs for a subscription.
- [/api/v5/authorize/](https://percolate.dev/reference/authenticate.md): This API allows a user to authenticate and to create a grant.
- [/api/v5/tenant/{tenant_id}/settings](https://percolate.dev/reference/gettenantsettings.md): Get tenant-specific settings
- [/api/v5/tenant/{tenant_id}/settings](https://percolate.dev/reference/updatetenantsettings.md): Update tenant-specific settings.

## Changelog
- [2021-07-02](https://percolate.dev/changelog/2021-07-02.md)
- [2021-03-03](https://percolate.dev/changelog/2021-03-03.md)
- [2020-02-11](https://percolate.dev/changelog/2020-02-11.md)
- [2020-02-01](https://percolate.dev/changelog/2020-02-01.md)
- [2021-01-15](https://percolate.dev/changelog/2021-01-15.md)
- [2020-12-03](https://percolate.dev/changelog/2020-12-03-2.md)
- [2020-12-03](https://percolate.dev/changelog/2020-12-03.md)
- [2020-12-02](https://percolate.dev/changelog/2020-12-02-1.md)
- [2020-11-30](https://percolate.dev/changelog/2020-11-30.md)
- [2020-11-27](https://percolate.dev/changelog/2020-11-27.md)