An Approval is created when you or someone on your team authorizes an action on Plane.For example, when you approve a Payment Request, we will create an Approval record to reflect that.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Plane Documentation","colors":{"primary":"#8365B6","light":"#C8ACDD","dark":"#2E1F4F"},"logo":{"light":"https://mintcdn.com/plane/PXSY9Ci77e3sBPBs/logo/light.svg?fit=max\u0026auto=format\u0026n=PXSY9Ci77e3sBPBs\u0026q=85\u0026s=a7ae554a8cec7419f1a8e1388d4e1b43","dark":"https://mintcdn.com/plane/PXSY9Ci77e3sBPBs/logo/dark.svg?fit=max\u0026auto=format\u0026n=PXSY9Ci77e3sBPBs\u0026q=85\u0026s=5de7dfbf517ec13a7b20412992ce5297"},"favicon":"https://mintcdn.com/plane/LkeMDqkKBiOTaO5G/favicon.png?fit=max\u0026auto=format\u0026n=LkeMDqkKBiOTaO5G\u0026q=85\u0026s=56c044e8c966814b60011ccbb40773bb","api":{"playground":{"display":"simple"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.plane.com"}},"background":{"color":{"light":"#F9FAF9","dark":"#090014"}},"navbar":{"links":[{"href":"mailto:support@plane.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://manage.plane.com"}},"footer":{"socials":{"twitter":"https://twitter.com/useplane","github":"https://github.com/planehq","linkedin":"https://www.linkedin.com/company/planehr"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"integrations":{"koala":{"publicApiKey":"pk_a5cb0421ee093920c345d114a0e692cd34da"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"plane","hasAudioNarration":false,"actualSubdomain":"plane","customDomains":["docs.plane.com"],"gitSource":{"type":"github","owner":"planehq","repo":"plane","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af0a53e9dea37c9b4625359","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":243},{"language":"default","tag":"Changelog","count":148},{"language":"default","tag":"HR","count":62},{"language":"default","tag":"Core Resources","count":61},{"language":"default","tag":"Time","count":42},{"language":"default","tag":"Time Off","count":33},{"language":"default","tag":"2023","count":30},{"language":"default","tag":"Product","count":30},{"language":"default","tag":"Payments","count":29},{"language":"default","tag":"2022","count":28}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#navigation-items li>button{align-items:center}#content-area{max-width:48rem}@media (max-width: 767px){.stable-scrollbar-gutter{padding-left:1.25rem!important;padding-right:1.25rem!important}}#pagination{margin-top:2rem}body:has(#navbar a[href=\"/changelog\"][data-active=\"true\"]) #content-area img{margin-top:1.5rem;margin-bottom:1.5rem}body:has(#navbar a[href=\"/changelog\"][data-active=\"true\"]) #header>.text-lg{margin-top:1rem}"}],"page":{"pagePath":"reference/approvals/object","slug":"/reference/approvals/object","pageMetadata":{"title":"Approval","sidebarTitle":"Approvals","icon":"user-check","description":null,"href":"/reference/approvals/object"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`An `,_jsx(_components.code,{children:`Approval`}),` is created when you or someone on your team authorizes an action on Plane.`]}),`\n`,_jsxs(_components.p,{children:[`For example, when you approve a `,_jsx(_components.code,{children:`Payment Request`}),`, we will create an `,_jsx(_components.code,{children:`Approval`}),` record to reflect that.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Approval","sidebarTitle":"Approvals","icon":"user-check","description":null,"href":"/reference/approvals/object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"plane","siteName":"Plane Documentation","title":"Approval - Plane Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T17:56:35.843Z","originalFileLocation":"reference/approvals/object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Plane Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Approval - Plane Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Plane Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.plane.com/reference/approvals/object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://plane.mintlify.site/_mintlify/api/og/v2?division=Core+Resources\u0026amp;title=Approval\u0026amp;theme=becd04f5f2c0078b8d7b15ac\u0026amp;signature=279052f4e6d4a98867e3b4c67d7ea3a870d236d21f53bbec295aecc222867b63\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Approval - Plane Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://plane.mintlify.site/_mintlify/api/og/v2?division=Core+Resources\u0026amp;title=Approval\u0026amp;theme=becd04f5f2c0078b8d7b15ac\u0026amp;signature=279052f4e6d4a98867e3b4c67d7ea3a870d236d21f53bbec295aecc222867b63\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/plane/cEzBBu81PjHlcxE2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Plane Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8365B6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.plane.com/reference/approvals/object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/approvals/object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.plane.com/#organization\",\"name\":\"Plane Documentation\",\"url\":\"https://docs.plane.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/plane/PXSY9Ci77e3sBPBs/logo/light.svg?fit=max\u0026auto=format\u0026n=PXSY9Ci77e3sBPBs\u0026q=85\u0026s=a7ae554a8cec7419f1a8e1388d4e1b43\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.plane.com#website\",\"name\":\"Plane Documentation\",\"url\":\"https://docs.plane.com\",\"publisher\":{\"@id\":\"https://docs.plane.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.plane.com/reference/approvals/object#webpage\",\"url\":\"https://docs.plane.com/reference/approvals/object\",\"name\":\"Approval\",\"dateModified\":\"2026-11-05T17:56:35.843Z\",\"isPartOf\":{\"@id\":\"https://docs.plane.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.plane.com/reference/approvals/object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.plane.com/reference/approvals/object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://docs.plane.com/reference/workspaces/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Approval\",\"item\":\"https://docs.plane.com/reference/approvals/object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.plane.com/reference/approvals/object#article\",\"headline\":\"Approval\",\"name\":\"Approval\",\"url\":\"https://docs.plane.com/reference/approvals/object\",\"mainEntityOfPage\":{\"@id\":\"https://docs.plane.com/reference/approvals/object#webpage\"},\"dateModified\":\"2026-11-05T17:56:35.843Z\",\"publisher\":{\"@id\":\"https://docs.plane.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.plane.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Plane Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Plane Documentation","nav":{"global":null,"tabs":[{"tab":"Product","pages":[{"title":"Product","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","pages":[{"group":"Working with the API","pages":[{"title":"Introduction","href":"/reference/introduction"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Versioning","href":"/reference/versioning"},{"title":"Pagination","href":"/reference/pagination"},{"title":"Idempotency","href":"/reference/idempotency"},{"title":"Errors","href":"/reference/errors"},{"title":"Webhooks","href":"/reference/webhooks"},{"title":"Sandboxes","href":"/reference/sandboxes"},{"title":"Partners","href":"/reference/partners"}]},{"group":"Core Resources","pages":[{"group":"Workspaces","icon":"layer-group","pages":[{"title":"Workspace","sidebarTitle":"Workspace object","href":"/reference/workspaces/object"},{"title":"Create a workspace","api":"POST /v1/workspaces","href":"/reference/workspaces/create"},{"title":"List workspaces","api":"GET /v1/workspaces","href":"/reference/workspaces/list"},{"title":"Get a workspace","api":"GET /v1/workspaces/{id}","href":"/reference/workspaces/get"}]},{"group":"Members","pages":[{"title":"The Member object","href":"/reference/members/object"},{"title":"Create a member","api":"POST /v1/members","href":"/reference/members/create"},{"title":"List members","api":"GET /v1/members","href":"/reference/members/list"},{"title":"Retrieve a member","api":"GET /v1/members/{id}","href":"/reference/members/get"}]},{"group":"Preferences","pages":[{"title":"Preference","sidebarTitle":"Preference object","href":"/reference/preferences/object"},{"title":"List preferences","api":"GET /v1/preferences","href":"/reference/preferences/list"},{"title":"Get a preference","api":"GET /v1/preferences/{key}","href":"/reference/preferences/get"},{"title":"Update a preference","api":"PATCH /v1/preferences/{key}","href":"/reference/preferences/update"},{"title":"Reset a preference","api":"DELETE /v1/preferences/{key}","href":"/reference/preferences/reset"},{"title":"List preference definitions","api":"GET /v1/preference-definitions","href":"/reference/preferences/definitions"},{"title":"Get a preference definition","api":"GET /v1/preference-definitions/{key}","href":"/reference/preferences/definition"}]},{"group":"Sandboxes","icon":"flask","pages":[{"title":"Sandbox","sidebarTitle":"Sandbox object","href":"/reference/sandboxes-object"},{"title":"Create a sandbox","api":"POST /v1/sandboxes","href":"/reference/sandboxes-create"},{"title":"List sandboxes","api":"GET /v1/sandboxes","href":"/reference/sandboxes-list"},{"title":"Get a sandbox","api":"GET /v1/sandboxes/{id}","href":"/reference/sandboxes-get"}]},{"group":"Entities","icon":"buildings","pages":[{"title":"Entity","sidebarTitle":"Entity object","href":"/reference/entities/object"},{"title":"Create an entity","api":"POST /v1/entities","href":"/reference/entities/create"},{"title":"List entities","api":"GET /v1/entities","href":"/reference/entities/list"},{"title":"Get an entity","api":"GET /v1/entities/{id}","href":"/reference/entities/get"},{"title":"Update an entity","api":"PATCH /v1/entities/{id}","href":"/reference/entities/update"}]},{"group":"Objects","icon":"layer-group","pages":[{"title":"Object","sidebarTitle":"Object definition","href":"/reference/object-types/object"},{"title":"Create an object","api":"POST /v1/object-types","href":"/reference/object-types/create"},{"title":"List objects","api":"GET /v1/object-types","href":"/reference/object-types/list"},{"title":"Get an object","api":"GET /v1/object-types/{key}","href":"/reference/object-types/get"},{"title":"Workspace records","href":"/reference/objects/records"},{"title":"Create a record","api":"POST /v1/objects/{object_slug}","href":"/reference/objects/create"},{"title":"List records","api":"GET /v1/objects/{object_slug}","href":"/reference/objects/list"},{"title":"Get a record","api":"GET /v1/objects/{object_slug}/{id}","href":"/reference/objects/get"},{"title":"Update a record","api":"PATCH /v1/objects/{object_slug}/{id}","href":"/reference/objects/update"},{"title":"Archive a record","api":"POST /v1/objects/{object_slug}/{id}/archive","href":"/reference/objects/archive"},{"title":"Create an attribute","api":"POST /v1/attributes","href":"/reference/attributes/create"},{"title":"Get an attribute","api":"GET /v1/attributes/{id}","href":"/reference/attributes/get"},{"title":"List attributes","api":"GET /v1/attributes","href":"/reference/attributes/list"},{"title":"Update an attribute","api":"PATCH /v1/attributes/{id}","href":"/reference/attributes/update"},{"title":"Archive an attribute","api":"POST /v1/attributes/{id}/archive","href":"/reference/attributes/archive"},{"title":"Restore an attribute","api":"POST /v1/attributes/{id}/restore","href":"/reference/attributes/restore"}]},{"group":"Approval policies","pages":[{"title":"Create an approval policy","api":"POST /v1/approval-policies","href":"/reference/approval-policies/create"},{"title":"Get an approval policy","api":"GET /v1/approval-policies/{id}","href":"/reference/approval-policies/get"},{"title":"List policies","api":"GET /v1/approval-policies","href":"/reference/approval-policies/list"},{"title":"Update an approval policy","api":"PATCH /v1/approval-policies/{id}","href":"/reference/approval-policies/update"},{"title":"Activate an approval policy","api":"POST /v1/approval-policies/{id}/activate","href":"/reference/approval-policies/activate"},{"title":"Pause an approval policy","api":"POST /v1/approval-policies/{id}/pause","href":"/reference/approval-policies/pause"},{"title":"Resume an approval policy","api":"POST /v1/approval-policies/{id}/resume","href":"/reference/approval-policies/resume"},{"title":"Revise an approval policy","api":"POST /v1/approval-policies/{id}/revise","href":"/reference/approval-policies/revise"}]},{"group":"Events","icon":"bolt","pages":[{"title":"Event","sidebarTitle":"Event object","href":"/reference/events/object"},{"title":"List events","api":"GET /v1/events","href":"/reference/events/list"},{"title":"Get an event","api":"GET /v1/events/{id}","href":"/reference/events/get"}]},{"group":"Routines","icon":"robot","pages":[{"title":"Routine run","sidebarTitle":"Routine run object","href":"/reference/routines/run-object"},{"title":"Create a routine run","api":"POST /v1/routines/{routine_id}/runs","href":"/reference/routines/create-run"}]},{"group":"Extracts","icon":"quote-right","pages":[{"title":"The extract object","href":"/reference/extracts/object"},{"title":"List extracts","api":"GET /v1/extracts","href":"/reference/extracts/list"},{"title":"Get an extract","api":"GET /v1/extracts/{id}","href":"/reference/extracts/get"}]},{"title":"Label","sidebarTitle":"Labels","icon":"tags","href":"/reference/labels/object"},{"title":"Project","sidebarTitle":"Projects","icon":"circle-three-quarters-stroke","href":"/reference/projects/object"},{"title":"Checklist","sidebarTitle":"Checklists","icon":"list-check","href":"/reference/checklists/object"},{"title":"Task","sidebarTitle":"Tasks","icon":"square-check","description":null,"href":"/reference/tasks/object"},{"title":"Approval","sidebarTitle":"Approvals","icon":"user-check","href":"/reference/approvals/object"}]},{"group":"HR","pages":[{"group":"Workers","icon":"address-card","pages":[{"title":"Worker","sidebarTitle":"Worker object","description":null,"href":"/reference/workers/object"},{"title":"Create a worker","api":"POST /v1/workers","href":"/reference/workers/create"},{"title":"List workers","api":"GET /v1/workers","href":"/reference/workers/list"},{"title":"Get a worker","api":"GET /v1/workers/{id}","href":"/reference/workers/get"},{"title":"Update a worker","api":"PATCH /v1/workers/{id}","href":"/reference/workers/update"},{"title":"Invite a worker","api":"POST /v1/workers/{id}/invite","href":"/reference/workers/invite"}]},{"group":"Employments","icon":"briefcase","pages":[{"title":"Employment","sidebarTitle":"Employment object","href":"/reference/employments/object"},{"title":"List employments","api":"GET /v1/employments","href":"/reference/employments/list"},{"title":"Get an employment","api":"GET /v1/employments/{id}","href":"/reference/employments/get"}]},{"group":"Compensations","icon":"sack-dollar","pages":[{"title":"Compensation","sidebarTitle":"Compensation object","href":"/reference/compensations/object"},{"title":"Create a compensation","api":"POST /v1/compensations","href":"/reference/compensations/create"},{"title":"List compensations","api":"GET /v1/compensations","href":"/reference/compensations/list"},{"title":"Get a compensation","api":"GET /v1/compensations/{id}","href":"/reference/compensations/get"}]},{"group":"Classifications","icon":"tags","pages":[{"title":"Classification","sidebarTitle":"Classification object","href":"/reference/classifications/object"},{"title":"List classifications","api":"GET /v1/classifications","href":"/reference/classifications/list"},{"title":"Get a classification","api":"GET /v1/classifications/{id}","href":"/reference/classifications/get"}]},{"group":"Locations","icon":"location-dot","pages":[{"title":"Location","sidebarTitle":"Location object","href":"/reference/locations/object"},{"title":"List locations","api":"GET /v1/locations","href":"/reference/locations/list"},{"title":"Get a location","api":"GET /v1/locations/{id}","href":"/reference/locations/get"},{"title":"Update a location","api":"PATCH /v1/locations/{id}","href":"/reference/locations/update"}]},{"group":"Roles","icon":"helmet-safety","pages":[{"title":"Role","sidebarTitle":"Role object","href":"/reference/roles/object"},{"title":"List roles","api":"GET /v1/roles","href":"/reference/roles/list"},{"title":"Get a role","api":"GET /v1/roles/{id}","href":"/reference/roles/get"}]},{"group":"Reportings","icon":"sitemap","pages":[{"title":"Reporting","sidebarTitle":"Reporting object","href":"/reference/reportings/object"},{"title":"List reportings","api":"GET /v1/reportings","href":"/reference/reportings/list"},{"title":"Get a reporting","api":"GET /v1/reportings/{id}","href":"/reference/reportings/get"}]},{"group":"Positions","icon":"user-plus","pages":[{"title":"Position","sidebarTitle":"Position object","href":"/reference/positions/object"},{"title":"Create a position","api":"POST /v1/positions","href":"/reference/positions/create"},{"title":"List positions","api":"GET /v1/positions","href":"/reference/positions/list"},{"title":"Retrieve a position","api":"GET /v1/positions/{id}","href":"/reference/positions/get"},{"title":"Update a position","api":"PATCH /v1/positions/{id}","href":"/reference/positions/update"},{"title":"Delete a position","api":"DELETE /v1/positions/{id}","href":"/reference/positions/delete"}]},{"group":"Offers","icon":"envelope-open-text","pages":[{"title":"Offer","sidebarTitle":"Offer object","href":"/reference/offers/object"},{"title":"Create an offer","api":"POST /v1/offers","href":"/reference/offers/create"},{"title":"List offers","api":"GET /v1/offers","href":"/reference/offers/list"},{"title":"Retrieve an offer","api":"GET /v1/offers/{id}","href":"/reference/offers/get"},{"title":"Update an offer","api":"PATCH /v1/offers/{id}","href":"/reference/offers/update"},{"title":"Send an offer","api":"POST /v1/offers/{id}/send","href":"/reference/offers/send"},{"title":"Resend an offer","api":"POST /v1/offers/{id}/resend","href":"/reference/offers/resend"},{"title":"Extend an offer","api":"POST /v1/offers/{id}/extend","href":"/reference/offers/extend"},{"title":"Void an offer","api":"POST /v1/offers/{id}/void","href":"/reference/offers/void"}]},{"group":"Dependents","icon":"people-roof","pages":[{"title":"Worker dependent","sidebarTitle":"Worker dependent object","href":"/reference/worker-dependents/object"},{"title":"Create a worker dependent","api":"POST /v1/worker-dependents","href":"/reference/worker-dependents/create"},{"title":"List worker dependents","api":"GET /v1/worker-dependents","href":"/reference/worker-dependents/list"},{"title":"Retrieve a worker dependent","api":"GET /v1/worker-dependents/{id}","href":"/reference/worker-dependents/get"},{"title":"Update a worker dependent","api":"PATCH /v1/worker-dependents/{id}","href":"/reference/worker-dependents/update"}]},{"group":"Addresses","icon":"map-location-dot","pages":[{"title":"Worker address","sidebarTitle":"Worker address object","href":"/reference/worker-addresses/object"},{"title":"Create a worker address","api":"POST /v1/worker-addresses","href":"/reference/worker-addresses/create"},{"title":"List worker addresses","api":"GET /v1/worker-addresses","href":"/reference/worker-addresses/list"},{"title":"Get a worker address","api":"GET /v1/worker-addresses/{id}","href":"/reference/worker-addresses/get"},{"title":"Update a worker address","api":"PATCH /v1/worker-addresses/{id}","href":"/reference/worker-addresses/update"},{"title":"Delete a worker address","api":"DELETE /v1/worker-addresses/{id}","href":"/reference/worker-addresses/delete"}]},{"group":"Contacts","icon":"address-book","pages":[{"title":"Worker contact","sidebarTitle":"Worker contact object","href":"/reference/worker-contacts/object"},{"title":"Create a worker contact","api":"POST /v1/worker-contacts","href":"/reference/worker-contacts/create"},{"title":"List worker contacts","api":"GET /v1/worker-contacts","href":"/reference/worker-contacts/list"},{"title":"Get a worker contact","api":"GET /v1/worker-contacts/{id}","href":"/reference/worker-contacts/get"},{"title":"Update a worker contact","api":"PATCH /v1/worker-contacts/{id}","href":"/reference/worker-contacts/update"}]},{"group":"Beneficiaries","icon":"hand-holding-heart","pages":[{"title":"Worker beneficiary","sidebarTitle":"Worker beneficiary object","href":"/reference/worker-beneficiaries/object"},{"title":"Create a worker beneficiary","api":"POST /v1/worker-beneficiaries","href":"/reference/worker-beneficiaries/create"},{"title":"List worker beneficiaries","api":"GET /v1/worker-beneficiaries","href":"/reference/worker-beneficiaries/list"},{"title":"Retrieve a worker beneficiary","api":"GET /v1/worker-beneficiaries/{id}","href":"/reference/worker-beneficiaries/get"},{"title":"Update a worker beneficiary","api":"PATCH /v1/worker-beneficiaries/{id}","href":"/reference/worker-beneficiaries/update"}]}]},{"group":"Workforce","pages":[{"group":"Plans","icon":"users","pages":[{"title":"Workforce plan","sidebarTitle":"Workforce plan object","href":"/reference/workforce-plans/object"},{"title":"Create a workforce plan","api":"POST /v1/workforce/plans","href":"/reference/workforce-plans/create"},{"title":"List workforce plans","api":"GET /v1/workforce/plans","href":"/reference/workforce-plans/list"},{"title":"Retrieve a workforce plan","api":"GET /v1/workforce/plans/{id}","href":"/reference/workforce-plans/get"},{"title":"Update a workforce plan","api":"PATCH /v1/workforce/plans/{id}","href":"/reference/workforce-plans/update"}]},{"group":"Calculations","icon":"calculator","pages":[{"title":"Workforce calculation","sidebarTitle":"Workforce calculation object","href":"/reference/workforce-calculations/object"},{"title":"Create a workforce calculation","api":"POST /v1/workforce/calculations","href":"/reference/workforce-calculations/create"},{"title":"Get a workforce calculation","api":"GET /v1/workforce/calculations/{id}","href":"/reference/workforce-calculations/get"}]}]},{"group":"Benefits","pages":[{"group":"Programs","icon":"umbrella","pages":[{"title":"Benefit program","sidebarTitle":"Benefit program object","href":"/reference/benefit-programs/object"},{"title":"Create a benefit program","api":"POST /v1/benefit/programs","href":"/reference/benefit-programs/create"},{"title":"List benefit programs","api":"GET /v1/benefit/programs","href":"/reference/benefit-programs/list"},{"title":"Retrieve a benefit program","api":"GET /v1/benefit/programs/{id}","href":"/reference/benefit-programs/get"},{"title":"Update a benefit program","api":"PATCH /v1/benefit/programs/{id}","href":"/reference/benefit-programs/update"}]},{"group":"Plans","icon":"file-shield","pages":[{"title":"Benefit plan","sidebarTitle":"Benefit plan object","href":"/reference/benefit-plans/object"},{"title":"Create a benefit plan","api":"POST /v1/benefit/plans","href":"/reference/benefit-plans/create"},{"title":"List benefit plans","api":"GET /v1/benefit/plans","href":"/reference/benefit-plans/list"},{"title":"Retrieve a benefit plan","api":"GET /v1/benefit/plans/{id}","href":"/reference/benefit-plans/get"},{"title":"Update a benefit plan","api":"PATCH /v1/benefit/plans/{id}","href":"/reference/benefit-plans/update"}]},{"group":"Events","icon":"calendar-day","pages":[{"title":"Benefit event","sidebarTitle":"Benefit event object","href":"/reference/benefit-events/object"},{"title":"Create a benefit event","api":"POST /v1/benefit/events","href":"/reference/benefit-events/create"},{"title":"List benefit events","api":"GET /v1/benefit/events","href":"/reference/benefit-events/list"},{"title":"Retrieve a benefit event","api":"GET /v1/benefit/events/{id}","href":"/reference/benefit-events/get"},{"title":"Update a benefit event","api":"PATCH /v1/benefit/events/{id}","href":"/reference/benefit-events/update"}]},{"group":"Enrollments","icon":"clipboard-list-check","pages":[{"title":"Benefit enrollment","sidebarTitle":"Benefit enrollment object","href":"/reference/benefit-enrollments/object"},{"title":"Create a benefit enrollment","api":"POST /v1/benefit/enrollments","href":"/reference/benefit-enrollments/create"},{"title":"List benefit enrollments","api":"GET /v1/benefit/enrollments","href":"/reference/benefit-enrollments/list"},{"title":"Retrieve a benefit enrollment","api":"GET /v1/benefit/enrollments/{id}","href":"/reference/benefit-enrollments/get"},{"title":"Submit a benefit enrollment","api":"POST /v1/benefit/enrollments/{id}/submit","href":"/reference/benefit-enrollments/submit"},{"title":"Cancel a benefit enrollment","api":"POST /v1/benefit/enrollments/{id}/cancel","href":"/reference/benefit-enrollments/cancel"}]},{"group":"Elections","icon":"clipboard-check","pages":[{"title":"Benefit election","sidebarTitle":"Benefit election object","href":"/reference/benefit-elections/object"},{"title":"Create a benefit election","api":"POST /v1/benefit/elections","href":"/reference/benefit-elections/create"},{"title":"List benefit elections","api":"GET /v1/benefit/elections","href":"/reference/benefit-elections/list"},{"title":"Retrieve a benefit election","api":"GET /v1/benefit/elections/{id}","href":"/reference/benefit-elections/get"},{"title":"Terminate a benefit election","api":"POST /v1/benefit/elections/{id}/terminate","href":"/reference/benefit-elections/terminate"}]}]},{"group":"Payments","pages":[{"group":"Payments","icon":"money-bill","pages":[{"title":"Payment","sidebarTitle":"Payment object","href":"/reference/payments/object"},{"title":"Create a payment","api":"POST /v1/payments","href":"/reference/payments/create"},{"title":"List payments","api":"GET /v1/payments","href":"/reference/payments/list"},{"title":"Get a payment","api":"GET /v1/payments/{id}","href":"/reference/payments/get"},{"title":"Cancel a payment","api":"POST /v1/payments/{id}/cancel","href":"/reference/payments/cancel"}]},{"group":"Payment Requests","icon":"envelope-open-dollar","pages":[{"title":"Payment Request","sidebarTitle":"Payment Request object","href":"/reference/payment-requests/object"},{"title":"Create a payment request","api":"POST /v1/payment-requests","href":"/reference/payment-requests/create"},{"title":"List payment requests","api":"GET /v1/payment-requests","href":"/reference/payment-requests/list"},{"title":"Get a payment request","api":"GET /v1/payment-requests/{id}","href":"/reference/payment-requests/get"},{"title":"Approve a payment request","api":"POST /v1/payment-requests/{id}/approve","href":"/reference/payment-requests/approve"},{"title":"Decline a payment request","api":"POST /v1/payment-requests/{id}/decline","href":"/reference/payment-requests/decline"},{"title":"Pay a payment request","api":"POST /v1/payment-requests/{id}/pay","href":"/reference/payment-requests/pay"}]},{"group":"Charges","icon":"square-dollar","pages":[{"title":"Charge","sidebarTitle":"Charge object","href":"/reference/charges/object"},{"title":"Create a charge","api":"POST /v1/charges","href":"/reference/charges/create"},{"title":"List charges","api":"GET /v1/charges","href":"/reference/charges/list"},{"title":"Get a charge","api":"GET /v1/charges/{id}","href":"/reference/charges/get"}]},{"group":"Refunds","icon":"left","pages":[{"title":"Refund","sidebarTitle":"Refund object","href":"/reference/refunds/object"},{"title":"List refunds","api":"GET /v1/refunds","href":"/reference/refunds/list"},{"title":"Get a refund","api":"GET /v1/refunds/{id}","href":"/reference/refunds/get"}]},{"group":"Sources","icon":"credit-card","pages":[{"title":"Source","sidebarTitle":"Source object","href":"/reference/sources/object"}]}]},{"group":"Payroll","pages":[{"group":"Payroll","icon":"circle-dollar","pages":[{"title":"Payroll","sidebarTitle":"Payroll object","href":"/reference/payrolls/object"},{"title":"List payrolls","api":"GET /v1/payrolls","href":"/reference/payrolls/list"},{"title":"Get a payroll","api":"GET /v1/payrolls/{id}","href":"/reference/payrolls/get"}]},{"group":"Payroll Changes","icon":"square-sliders","pages":[{"title":"Payroll Change","sidebarTitle":"Payroll Change object","href":"/reference/payroll-changes/object"}]}]},{"group":"Documents","pages":[{"group":"Documents","icon":"file-lines","pages":[{"title":"Document","sidebarTitle":"Document object","href":"/reference/documents/object"}]},{"group":"Contracts","icon":"file-signature","pages":[{"title":"Contract","sidebarTitle":"Contract object","href":"/reference/contracts/object"}]}]},{"group":"Time","pages":[{"group":"Time Off","icon":"island-tropical","pages":[{"title":"Leave","sidebarTitle":"Leave object","href":"/reference/leaves/object"},{"title":"Create a leave","api":"POST /v1/leaves","href":"/reference/leaves/create"},{"title":"Cancel a leave","api":"POST /v1/leaves/{id}/cancel","href":"/reference/leaves/cancel"},{"title":"List leaves","api":"GET /v1/leaves","href":"/reference/leaves/list"},{"title":"Get a leave","api":"GET /v1/leaves/{id}","href":"/reference/leaves/get"},{"group":"Leave Requests","pages":[{"title":"Leave Request","sidebarTitle":"Leave Request object","href":"/reference/leave-requests/object"},{"title":"Create a leave request","api":"POST /v1/leave-requests","href":"/reference/leave-requests/create"},{"title":"Approve a leave request","api":"POST /v1/leave-requests/{id}/approve","href":"/reference/leave-requests/approve"},{"title":"Decline a leave request","api":"POST /v1/leave-requests/{id}/decline","href":"/reference/leave-requests/decline"},{"title":"List leave requests","api":"GET /v1/leave-requests","href":"/reference/leave-requests/list"},{"title":"Get a leave request","api":"GET /v1/leave-requests/{id}","href":"/reference/leave-requests/get"}]},{"group":"Leave Policies","pages":[{"title":"Leave Policy","sidebarTitle":"Leave Policy object","href":"/reference/leave-policies/object"},{"title":"Create a leave policy","api":"POST /v1/leave-policies","href":"/reference/leave-policies/create"},{"title":"Update a leave policy","api":"PATCH /v1/leave-policies/{id}","href":"/reference/leave-policies/update"},{"title":"List leave policies","api":"GET /v1/leave-policies","href":"/reference/leave-policies/list"},{"title":"Get a leave policy","api":"GET /v1/leave-policies/{id}","href":"/reference/leave-policies/get"},{"title":"Delete a leave policy","api":"DELETE /v1/leave-policies/{id}","href":"/reference/leave-policies/delete"}]},{"group":"Leave Entitlements","pages":[{"title":"Leave Entitlement","sidebarTitle":"Leave Entitlement object","href":"/reference/leave-entitlements/object"},{"title":"Create a leave entitlement","api":"POST /v1/leave-entitlements","href":"/reference/leave-entitlements/create"},{"title":"Update a leave entitlement","api":"PATCH /v1/leave-entitlements/{id}","href":"/reference/leave-entitlements/update"},{"title":"List leave entitlements","api":"GET /v1/leave-entitlements","href":"/reference/leave-entitlements/list"},{"title":"Get a leave entitlement","api":"GET /v1/leave-entitlements/{id}","href":"/reference/leave-entitlements/get"},{"title":"Delete a leave entitlement","api":"DELETE /v1/leave-entitlements/{id}","href":"/reference/leave-entitlements/delete"}]},{"group":"Leave Balances","pages":[{"title":"Leave Balance","sidebarTitle":"Leave Balance object","href":"/reference/leave-balances/object"},{"title":"List leave balances","api":"GET /v1/leave-balances","href":"/reference/leave-balances/list"},{"title":"Get a leave balance","api":"GET /v1/leave-balances/{id}","href":"/reference/leave-balances/get"}]},{"group":"Leave Transactions","pages":[{"title":"Leave Transaction","sidebarTitle":"Leave Transaction object","href":"/reference/leave-transactions/object"},{"title":"List leave transactions","api":"GET /v1/leave-balances/{leave_balance_id}/transactions","href":"/reference/leave-transactions/list"},{"title":"Get a leave transaction","api":"GET /v1/leave-balances/{leave_balance_id}/transactions/{id}","href":"/reference/leave-transactions/get"},{"title":"Create a leave transaction","api":"POST /v1/leave-balances/{leave_balance_id}/transactions","href":"/reference/leave-transactions/create"}]}]},{"group":"Calendars","icon":"calendar-days","pages":[{"title":"Calendar","sidebarTitle":"Calendar object","href":"/reference/calendars/object"},{"title":"List calendars","api":"GET /v1/calendars","href":"/reference/calendars/list"},{"title":"Get a calendar","api":"GET /v1/calendars/{id}","href":"/reference/calendars/get"},{"title":"Calendar event","sidebarTitle":"Calendar event object","href":"/reference/calendar-events/object"},{"title":"List calendar events","api":"GET /v1/calendar-events","href":"/reference/calendar-events/list"},{"title":"Get a calendar event","api":"GET /v1/calendar-events/{id}","href":"/reference/calendar-events/get"}]},{"group":"Time Entries","icon":"clock","pages":[{"title":"Time Entry","sidebarTitle":"Time Entry object","href":"/reference/time-entries/object"},{"title":"Create a time entry","api":"POST /v1/time-entries","href":"/reference/time-entries/create"},{"title":"Update a time entry","api":"PATCH /v1/time-entries/{id}","href":"/reference/time-entries/update"},{"title":"List time entries","api":"GET /v1/time-entries","href":"/reference/time-entries/list"},{"title":"Get a time entry","api":"GET /v1/time-entries/{id}","href":"/reference/time-entries/get"},{"title":"Delete a time entry","api":"DELETE /v1/time-entries/{id}","href":"/reference/time-entries/delete"}]}]},{"group":"Labor","pages":[{"group":"Rules","icon":"scale-balanced","pages":[{"title":"The labor rule object","href":"/reference/labor-rules/object"},{"title":"List labor rules","api":"GET /v1/labor/rules","href":"/reference/labor-rules/list"},{"title":"Get a labor rule","api":"GET /v1/labor/rules/{id}","href":"/reference/labor-rules/get"}]},{"group":"Taxes","icon":"scale-balanced","pages":[{"title":"Labor tax","sidebarTitle":"Labor tax object","href":"/reference/labor-taxes/object"},{"title":"List labor taxes","api":"GET /v1/labor/taxes","href":"/reference/labor-taxes/list"},{"title":"Get a labor tax","api":"GET /v1/labor/taxes/{id}","href":"/reference/labor-taxes/get"}]}]},{"group":"Legal","pages":[{"group":"Sources","icon":"gavel","pages":[{"title":"The legal source object","sidebarTitle":"Legal source object","href":"/reference/legal-sources/object"},{"title":"List legal sources","api":"GET /v1/legal/sources","href":"/reference/legal-sources/list"},{"title":"Get a legal source","api":"GET /v1/legal/sources/{id}","href":"/reference/legal-sources/get"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Security","pages":[{"title":"Security","href":"/security/security-response-policy"}]}]},"basePath":"","title":"Approval - Plane Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}