{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starter Kit","colors":{"primary":"#1d4ed8","light":"#AE87FF","dark":"#0D001D"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/light.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=c51ca959c2189bc80849d307962fee76","dark":"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/dark.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=069a0a5702315c2cc8a214a707f9b757","href":"https://docs.hirehive.com"},"api":{"openapi":["openapi.json","jobs-openapi.json"],"playground":{"display":"interactive"}},"background":{"decoration":null,"color":{"light":null,"dark":"#0e171d"}},"navbar":{"links":[{"label":"Support","href":"mailto:support@hirehive.com"}],"primary":{"type":"button","label":"HireHive Dashboard","href":"https://app.hirehive.com"}},"footer":{"socials":{"twitter":"https://twitter.com/hirehive","github":"https://github.com/hirehive","linkedin":"https://www.linkedin.com/company/hirehive-io"}},"integrations":{"plausible":{"domain":"docs.hirehive.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hirehive","hasAudioNarration":false,"actualSubdomain":"hirehive","customDomains":["docs.hirehive.com"],"gitSource":{"type":"github","owner":"hirehive","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c3b9cd12361a7c950631","collectionId":"8c70c9cc-39c4-4eac-a341-53122a38f890","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6a20c3b9cd12361a7c950631:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":118},{"language":"default","tag":"API Reference","count":110},{"language":"default","tag":"Endpoints","count":84},{"language":"default","tag":"Settings","count":33},{"language":"default","tag":"Webhooks","count":27},{"language":"default","tag":"Events","count":19},{"language":"default","tag":"Jobs","count":12},{"language":"default","tag":"Candidates","count":10},{"language":"default","tag":"Application and Feedback forms","count":8},{"language":"default","tag":"Applications","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/object-ids","slug":"/api-reference/object-ids","pageMetadata":{"title":"Object IDs","description":"Human readable ID's provide a better experience for both users and developers, as they interact with and manage various entities within the system.","icon":"passport","href":"/api-reference/object-ids"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Human readable ID’s provide a better experience for both users and developers, as they interact with and manage various entities within the system.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`make-it-human-readable`,children:`Make it human readable`}),`\n`,_jsxs(_components.p,{children:[`At HireHive we use `,_jsx(_components.a,{href:`https://dev.to/stripe/designing-apis-for-humans-object-ids-3o5a`,children:`Human readable ID’s`}),` for our object identifiers. This was made popular by Stripe.`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`5`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`job_nBXhT202AnR1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|_| |__________|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` |_Prefix |_Random characters`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`list-of-id’s-in-hirehive`,children:`List of ID’s in HireHive`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Prefix`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`job_`}),_jsx(_components.td,{children:`Job Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`cat_`}),_jsx(_components.td,{children:`Job category Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`note_`}),_jsx(_components.td,{children:`The note Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`usr_`}),_jsx(_components.td,{children:`The user Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`usrcat_`}),_jsx(_components.td,{children:`The user category Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gst_`}),_jsx(_components.td,{children:`The guest Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`app_`}),_jsx(_components.td,{children:`The application Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`can_`}),_jsx(_components.td,{children:`The candidate Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`cv_`}),_jsx(_components.td,{children:`The resume Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`fdbk_`}),_jsx(_components.td,{children:`The feedback Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`int_`}),_jsx(_components.td,{children:`The interview Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`attd_`}),_jsx(_components.td,{children:`The interview attendee Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`shrdapp_`}),_jsx(_components.td,{children:`The shared application Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`form_`}),_jsx(_components.td,{children:`The form Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`qustn_`}),_jsx(_components.td,{children:`The question Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`opt_`}),_jsx(_components.td,{children:`The question option Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`file_`}),_jsx(_components.td,{children:`The file Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`tag_`}),_jsx(_components.td,{children:`The tag Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`acc_`}),_jsx(_components.td,{children:`The company Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`cnt_`}),_jsx(_components.td,{children:`The contact Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`mail_`}),_jsx(_components.td,{children:`The email Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`etmpl_`}),_jsx(_components.td,{children:`The email template Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`pipl_`}),_jsx(_components.td,{children:`The pipline stage Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`camp_`}),_jsx(_components.td,{children:`The referral campaign Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`adlog_`}),_jsx(_components.td,{children:`The audit log Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`api_`}),_jsx(_components.td,{children:`The api key Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`wbhk_`}),_jsx(_components.td,{children:`The webhook Id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`wbhk_evt_`}),_jsx(_components.td,{children:`The webhook event Id`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Object IDs","description":"Human readable ID's provide a better experience for both users and developers, as they interact with and manage various entities within the system.","icon":"passport","href":"/api-reference/object-ids"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Make it human readable","slug":"make-it-human-readable","depth":2,"children":[]},{"title":"List of ID’s in HireHive","slug":"list-of-id’s-in-hirehive","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"hirehive","siteName":"Starter Kit","title":"Object IDs - Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-06T14:41:36.293Z","originalFileLocation":"api-reference/object-ids.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=\"description\" content=\"Human readable ID\u0026#x27;s provide a better experience for both users and developers, as they interact with and manage various entities within the system.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Object IDs - Starter Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Human readable ID\u0026#x27;s provide a better experience for both users and developers, as they interact with and manage various entities within the system.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hirehive.com/api-reference/object-ids\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hirehive.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Object+IDs\u0026amp;description=Human+readable+ID%27s+provide+a+better+experience+for+both+users+and+developers%2C+as+they+interact+with+and+manage+various+entities+within+the+system.\u0026amp;theme=e8a4911129b59f4329852d8e\u0026amp;signature=a013038835dfd1dd8afae026d4c6c79277d5baf33b906eb4bc75952975f1c219\">\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=\"Object IDs - Starter Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Human readable ID\u0026#x27;s provide a better experience for both users and developers, as they interact with and manage various entities within the system.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hirehive.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Object+IDs\u0026amp;description=Human+readable+ID%27s+provide+a+better+experience+for+both+users+and+developers%2C+as+they+interact+with+and+manage+various+entities+within+the+system.\u0026amp;theme=e8a4911129b59f4329852d8e\u0026amp;signature=a013038835dfd1dd8afae026d4c6c79277d5baf33b906eb4bc75952975f1c219\">\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/hirehive/8CvQvXCUMBAiaJJ7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1d4ed8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hirehive.com/api-reference/object-ids\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/object-ids.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hirehive.com/#organization\",\"name\":\"Starter Kit\",\"url\":\"https://docs.hirehive.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hirehive/EwYKqLOxXCdMHqRI/logo/light.svg?fit=max\u0026auto=format\u0026n=EwYKqLOxXCdMHqRI\u0026q=85\u0026s=c51ca959c2189bc80849d307962fee76\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hirehive.com#website\",\"name\":\"Starter Kit\",\"url\":\"https://docs.hirehive.com\",\"publisher\":{\"@id\":\"https://docs.hirehive.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hirehive.com/api-reference/object-ids#webpage\",\"url\":\"https://docs.hirehive.com/api-reference/object-ids\",\"name\":\"Object IDs\",\"description\":\"Human readable ID's provide a better experience for both users and developers, as they interact with and manage various entities within the system.\",\"dateModified\":\"2025-11-06T14:41:36.293Z\",\"isPartOf\":{\"@id\":\"https://docs.hirehive.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hirehive.com/api-reference/object-ids#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hirehive.com/api-reference/object-ids#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docs.hirehive.com/api-reference/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Object IDs\",\"item\":\"https://docs.hirehive.com/api-reference/object-ids\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.hirehive.com/api-reference/object-ids#article\",\"headline\":\"Object IDs\",\"name\":\"Object IDs\",\"description\":\"Human readable ID's provide a better experience for both users and developers, as they interact with and manage various entities within the system.\",\"url\":\"https://docs.hirehive.com/api-reference/object-ids\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hirehive.com/api-reference/object-ids#webpage\"},\"dateModified\":\"2025-11-06T14:41:36.293Z\",\"publisher\":{\"@id\":\"https://docs.hirehive.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hirehive.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Starter Kit","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Authentication","icon":"fingerprint","href":"/api-reference/authentication"},{"title":"Pagination","icon":"list-ol","href":"/api-reference/pagination"},{"title":"Sorting","description":"Change the order of items returned in a list","icon":"arrow-up-z-a","href":"/api-reference/sorting-options"},{"title":"Object IDs","icon":"passport","href":"/api-reference/object-ids"}]},{"group":"Endpoints","pages":[{"group":"Applications","pages":[{"title":"Application object","description":null,"href":"/api-reference/applications/application-object"},{"title":"Get applications","openapi":"get /v1.0/{company_id}/applications","href":"/api-reference/applications/get-v1-applications"},{"title":"Get application","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}","href":"/api-reference/applications/get-v1-candidates-applications"},{"title":"Get questions for application","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/questions","href":"/api-reference/applications/get-v1-candidates-applications-questions"},{"title":"Get resume","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/resume/{resume_id}/{file_version}","href":"/api-reference/applications/get-v1-candidates-applications-resume-"},{"title":"Update source","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/source","href":"/api-reference/applications/put-v1-candidates-applications-source"},{"title":"Change application stage","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/stage","href":"/api-reference/applications/put-v1-candidates-applications-stage"}]},{"group":"Candidates","pages":[{"title":"Candidate object","href":"/api-reference/candidates/candidate-object"},{"title":"Get candidates","openapi":"get /v1.0/{company_id}/candidates","href":"/api-reference/candidates/list"},{"title":"Get candidate by id","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}","href":"/api-reference/candidates/get-by-id"},{"title":"Update candidate","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}","href":"/api-reference/candidates/update"},{"group":"Candidate Notes","pages":[{"title":"Get notes","openapi":"get /v1.0/{company_id}/candidates/{candidate_id}/notes","href":"/api-reference/candidate-notes/list"},{"title":"Create note","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/notes","href":"/api-reference/candidate-notes/create"},{"title":"Update note","openapi":"put /v1.0/{company_id}/candidates/{candidate_id}/notes/{note_id}","href":"/api-reference/candidate-notes/update"},{"title":"Delete note","openapi":"delete /v1.0/{company_id}/candidates/{candidate_id}/notes/{note_id}","href":"/api-reference/candidate-notes/delete"}]},{"group":"Candidate Tags","pages":[{"title":"Tag candidate","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/tags","href":"/api-reference/candidate-tags/add-tag"},{"title":"Remove tag","openapi":"delete /v1.0/{company_id}/candidates/{candidate_id}/tags/{tag_id}","href":"/api-reference/candidate-tags/remove-tag"}]}]},{"group":"Jobs","pages":[{"title":"Job object","href":"/api-reference/jobs/job-object"},{"title":"Get jobs","openapi":"get /v1.0/{company_id}/jobs","href":"/api-reference/jobs/list"},{"title":"Get job by id","openapi":"get /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/get-by-id"},{"title":"Create job","openapi":"post /v1.0/{company_id}/jobs","href":"/api-reference/jobs/create"},{"title":"Update job","openapi":"put /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/update"},{"title":"Change job status","openapi":"put /v1.0/{company_id}/jobs/{job_id}/status","href":"/api-reference/jobs/change-status"},{"title":"Delete job","openapi":"delete /v1.0/{company_id}/jobs/{job_id}","href":"/api-reference/jobs/delete"},{"group":"Jobs Notes","pages":[{"title":"Get notes","openapi":"get /v1.0/{company_id}/jobs/{job_id}/notes","href":"/api-reference/jobnotes/list"},{"title":"Get note by id","openapi":"get /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/get-by-id"},{"title":"Create note","openapi":"post /v1.0/{company_id}/jobs/{job_id}/notes","href":"/api-reference/jobnotes/create"},{"title":"Update note","openapi":"put /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/update"},{"title":"Delete note","openapi":"delete /v1.0/{company_id}/jobs/{job_id}/notes/{note_id}","href":"/api-reference/jobnotes/delete"}]}]},{"group":"Feedback","pages":[{"title":"Get feedback","openapi":"get /v1.0/{company_id}/feedback","href":"/api-reference/feedback/get"},{"title":"Complete feedback","openapi":"post /v1.0/{company_id}/feedback","href":"/api-reference/feedback/create"},{"title":"Update feedback","openapi":"put /v1.0/{company_id}/feedback/{feedback_id}","href":"/api-reference/feedback/update"},{"title":"Request feedback","openapi":"post /v1.0/{company_id}/candidates/{candidate_id}/applications/{application_id}/feedback/request","href":"/api-reference/feedback/request"}]},{"group":"Interviews","pages":[{"title":"Get interviews","openapi":"get /v1.0/{company_id}/interviews","href":"/api-reference/interviews/list"},{"title":"Get interview by id","openapi":"get /v1.0/{company_id}/interviews/{interview_id}","href":"/api-reference/interviews/get-by-id"},{"title":"Create interview","openapi":"post /v1.0/{company_id}/interviews","href":"/api-reference/interviews/create"},{"title":"Update interview","openapi":"put /v1.0/{company_id}/interviews/{interview_id}","href":"/api-reference/interviews/update"},{"title":"Cancel interview","openapi":"put /v1.0/{company_id}/interviews/{interview_id}/cancel","href":"/api-reference/interviews/cancel"}]},{"group":"Users","pages":[{"title":"User permissions","href":"/api-reference/users/permissions"},{"title":"Get users","openapi":"get /v1.0/{company_id}/users","href":"/api-reference/users/list"},{"title":"Get user by id","openapi":"get /v1.0/{company_id}/users/{id}","href":"/api-reference/users/get-by-id"},{"title":"Create user","openapi":"post /v1.0/{company_id}/users","href":"/api-reference/users/create"},{"title":"Update user","openapi":"put /v1.0/{company_id}/users/{id}","href":"/api-reference/users/update"},{"title":"Delete user","openapi":"delete /v1.0/{company_id}/users/{id}","href":"/api-reference/users/delete"}]},{"group":"Files","pages":[{"title":"Get file by id","openapi":"get /v1.0/{company_id}/files/{file_id}","href":"/api-reference/files/get-by-id"},{"title":"Upload File","openapi":"post /v1.0/{company_id}/files","href":"/api-reference/files/upload"}]},{"group":"Settings","pages":[{"group":"User Categories","pages":[{"title":"Get user categories","openapi":"get /v1.0/{company_id}/users/categories","href":"/api-reference/usercategories/list"},{"title":"Get user categories by id","openapi":"get /v1.0/{company_id}/users/categories/{category_id}","href":"/api-reference/usercategories/get-by-id"},{"title":"Create a new user category","openapi":"post /v1.0/{company_id}/users/categories","href":"/api-reference/usercategories/create"},{"title":"Update a user category","openapi":"put /v1.0/{company_id}/users/categories/{id}","href":"/api-reference/usercategories/update"},{"title":"Delete category","openapi":"delete /v1.0/{company_id}/users/categories/{id}","href":"/api-reference/usercategories/delete"}]},{"group":"Job Categories","pages":[{"title":"Get categories","openapi":"get /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/list"},{"title":"Get category","openapi":"get /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/get-by-id"},{"title":"Create category","openapi":"post /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/create"},{"title":"Update category","openapi":"put /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/update"},{"title":"Order categories","openapi":"put /v1.0/{company_id}/jobs/categories","href":"/api-reference/jobcategories/update-order"},{"title":"Delete category","openapi":"delete /v1.0/{company_id}/jobs/categories/{category_id}","href":"/api-reference/jobcategories/delete"}]},{"group":"Email Templates","pages":[{"title":"Get templates","openapi":"get /v1.0/{company_id}/emailtemplates","href":"/api-reference/emailtemplates/list"},{"title":"Create template","openapi":"post /v1.0/{company_id}/emailtemplates","href":"/api-reference/emailtemplates/create"},{"title":"Update template","openapi":"put /v1.0/{company_id}/emailtemplates/{id}","href":"/api-reference/emailtemplates/update"},{"title":"Delete template","openapi":"delete /v1.0/{company_id}/emailtemplates/{id}","href":"/api-reference/emailtemplates/delete"}]},{"group":"Manage Tags","pages":[{"title":"Get tags","openapi":"get /v1.0/{company_id}/tags","href":"/api-reference/tags/list"},{"title":"Get tag","openapi":"get /v1.0/{company_id}/tags/{tag_id}","href":"/api-reference/tags/get-by-id"},{"title":"Create a tag","openapi":"post /v1.0/{company_id}/tags","href":"/api-reference/tags/create"},{"title":"Update tag","openapi":"put /v1.0/{company_id}/tags/{tag_id}","href":"/api-reference/tags/update"}]},{"group":"Pipeline stages","pages":[{"title":"Get stages","openapi":"get /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/list"},{"title":"Get stage by id","openapi":"get /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/get-by-id"},{"title":"Create new stage","openapi":"post /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/create"},{"title":"Update state","openapi":"put /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/update"},{"title":"Reorder stages","openapi":"put /v1.0/{company_id}/pipeline-stages","href":"/api-reference/pipeline/update-order"},{"title":"Delete a stage","openapi":"delete /v1.0/{company_id}/pipeline-stages/{id}","href":"/api-reference/pipeline/delete"}]},{"group":"Application and Feedback forms","pages":[{"title":"Get forms","openapi":"get /v1.0/{company_id}/forms/application","href":"/api-reference/forms/list"},{"title":"Get form","openapi":"get /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/get-by-id"},{"title":"Create form","openapi":"post /v1.0/{company_id}/forms/application","href":"/api-reference/forms/create"},{"title":"Update form","openapi":"put /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/update"},{"title":"Duplicate form","openapi":"put /v1.0/{company_id}/forms/application/{form_id}/duplicate","href":"/api-reference/forms/duplicate"},{"title":"Delete form","openapi":"delete /v1.0/{company_id}/forms/application/{form_id}","href":"/api-reference/forms/delete"},{"group":"Base form","pages":[{"title":"Get base form","openapi":"get /v1.0/{company_id}/forms/application/default","href":"/api-reference/forms/get-base"},{"title":"Update base form","openapi":"put /v1.0/{company_id}/forms/application/default","href":"/api-reference/forms/update-base"}]}]}]},{"group":"Webhooks","pages":[{"title":"Get webhooks","openapi":"get /v1.0/{company_id}/webhooks","href":"/api-reference/webhooks/list"},{"title":"Get webhook","openapi":"get /v1.0/{company_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-by-id"},{"title":"Get a paginated list of webhook events","openapi":"get /v1.0/{company_id}/webhooks/events","href":"/api-reference/webhooks/get-events"},{"title":"Create a webhook","openapi":"post /v1.0/{company_id}/webhooks","href":"/api-reference/webhooks/create"},{"title":"Update webhook","openapi":"put /v1.0/{company_id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/update"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","icon":"circle-info","href":"/api-reference/webhooks/introduction"},{"title":"Verify Webhook Signatures","icon":"key","href":"/api-reference/webhooks/validating-webhook-signatures"},{"title":"Webhook retries","icon":"repeat","href":"/api-reference/webhooks/webhook-retries"},{"group":"Events","pages":[{"title":"job.created","href":"/api-reference/webhooks/events/job.created"},{"title":"job.updated","href":"/api-reference/webhooks/events/job.updated"},{"title":"job.status.updated","href":"/api-reference/webhooks/events/job.status.updated"},{"title":"job.deleted","href":"/api-reference/webhooks/events/job.deleted"},{"title":"application.created","href":"/api-reference/webhooks/events/application.created"},{"title":"application.stage.updated","href":"/api-reference/webhooks/events/application.stage.updated"},{"title":"application.deleted","href":"/api-reference/webhooks/events/application.deleted"},{"title":"candidate.updated","href":"/api-reference/webhooks/events/candidate.updated"},{"title":"candidate.note.created","href":"/api-reference/webhooks/events/candidate.note.created"},{"title":"candidate.note.updated","href":"/api-reference/webhooks/events/candidate.note.updated"},{"title":"candidate.note.deleted","href":"/api-reference/webhooks/events/candidate.note.deleted"},{"title":"candidate.tag.added","href":"/api-reference/webhooks/events/candidate.tag.added"},{"title":"candidate.tag.removed","href":"/api-reference/webhooks/events/candidate.tag.removed"},{"title":"feedback.requested","href":"/api-reference/webhooks/events/feedback.requested"},{"title":"feedback.submitted","href":"/api-reference/webhooks/events/feedback.submitted"},{"title":"feedback.updated","href":"/api-reference/webhooks/events/feedback.updated"},{"title":"interview.created","href":"/api-reference/webhooks/events/interview.created"},{"title":"interview.updated","href":"/api-reference/webhooks/events/interview.updated"},{"title":"interview.cancelled","href":"/api-reference/webhooks/events/interview.cancelled"}]}]}]},{"tab":"Website integration","pages":[{"title":"Website integration","href":"/website-integration/introduction"}]}]},{"anchor":"Documentation","icon":"book-open-cover","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"Community","href":"https://twitter.com/hirehive","icon":"twitter"},{"anchor":"Blog","href":"https://www.hirehive.com/recruiting-blog/","icon":"newspaper"}]},"title":"Object IDs - Starter Kit","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}
