Users connect their payroll accounts through Items in Link.
Our Items guide provides more information on how to retrieve:
Which data fields an Item supports, and how often an Item is re-scanned for new data.
Whether an Item is healthy and supports new connections or is experiencing issues.
What data limits or other constraints the Item’s underlying payroll system has, if any.
The Item object
id
string
Unique ID of the Item. ID format — item_123456789
name
string
Name of the Item.
kind
enum<string>
Type of Item.
Available options:
employer,
gig,
platform,
benefits
known_limitations
string | null
Known limitations of the Item, such as historical data limits, unique behavior, or degree of value obfuscation. Otherwise null.
status
enum<string>
Health status of the Item.
healthy — Normal service.
issues — Impacted service. New account connections still supported.
unavailable — Impacted service. New account connections not supported. Ongoing refresh paused.
Available options:
healthy,
issues,
unavailable
status_details
string | null
Additional details on the Item's health status, such as degraded account connection ability or paused ongoing refresh. Otherwise null.
logo_url
string
URL location of the Item's logo image file.
is_grouping
boolean
true if the Item does not directly support account connections, but instead acts as a container for other Items.
mapping_status
enum<string>
Verification status of the Item.
verified — The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data.
mapped — The payroll system associated with the Item is known, but the Item is awaiting a successful connection.
unmapped — The payroll system associated with this Item is not yet known. If an unmapped Item is selected in Link, the user will be given the option to search for the relevant payroll system and attempt to connect using their login credentials.
Available options:
verified,
mapped,
unmapped
matching_score
string
Confidence score based on the degree of similarity between the Item and the search term. Ranges from "1.00" (strong match) to "0.01" (weak match).
matching_score is only returned when listing Items and is only applicable when the q "free-text search" query parameter is used.
Returned as a decimal string with exactly two decimal places.
features
object
What data fields the Item supports, the Item's deposit switching capabilities, and how often the Item is refreshed with new data.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Argyle Docs","colors":{"primary":"#214E48","light":"#7FB2A8","dark":"#1D1D1D"},"logo":{"light":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376","dark":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/dark.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=9fd2f436065a41825b9839fb81c76467","href":"/"},"favicon":"https://mintcdn.com/argyle/xZQDezYDpb8d7zmN/favicon.png?fit=max\u0026auto=format\u0026n=xZQDezYDpb8d7zmN\u0026q=85\u0026s=046e800dc429a2f398d20a345dd7350a","api":{"openapi":["openAPI/account-webhook-updated.yaml","openAPI/account-webhooks-added.yaml","openAPI/accounts-webhooks-connected.yaml","openAPI/accounts-webhooks-failed.yaml","openAPI/accounts-webhooks-removed.yaml","openAPI/accounts.yaml","openAPI/deposit-destinations.yaml","openAPI/employer-search.yaml","openAPI/employments.yaml","openAPI/gigs-webhooks-added.yaml","openAPI/gigs-webhooks-fully-synced.yaml","openAPI/gigs-webhooks-partially-synced.yaml","openAPI/gigs-webhooks-removed.yaml","openAPI/gigs-webhooks-updated.yaml","openAPI/gigs.yaml","openAPI/identities-webhooks-added.yaml","openAPI/identities-webhooks-updated.yaml","openAPI/identities.yaml","openAPI/invites.yaml","openAPI/item-filters.yaml","openAPI/items-webhooks-removed.yaml","openAPI/items-webhooks-updated.yaml","openAPI/items.yaml","openAPI/open-banking.yaml","openAPI/payroll-documents-webhooks-added.yaml","openAPI/payroll-documents-webhooks-ocr-completed.yaml","openAPI/payroll-documents-webhooks-ocr-failed.yaml","openAPI/payroll-documents-webhooks-removed.yaml","openAPI/payroll-documents-webhooks-updated.yaml","openAPI/payroll-documents.yaml","openAPI/paystubs-webhooks-added.yaml","openAPI/paystubs-webhooks-fully-synced.yaml","openAPI/paystubs-webhooks-partially-synced.yaml","openAPI/paystubs-webhooks-updated.yaml","openAPI/paystubs.yaml","openAPI/ratings-webhooks-added.yaml","openAPI/ratings-webhooks-updated.yaml","openAPI/ratings.yaml","openAPI/receipts.yaml","openAPI/reports-webhooks-generated.yaml","openAPI/reports-webhooks-ready.yaml","openAPI/reports.yaml","openAPI/shifts-webhooks-added.yaml","openAPI/shifts-webhooks-fully-synced.yaml","openAPI/shifts-webhooks-partially-synced.yaml","openAPI/shifts-webhooks-removed.yaml","openAPI/shifts-webhooks-updated.yaml","openAPI/shifts.yaml","openAPI/user-forms-webhooks-removed.yaml","openAPI/user-forms-webhooks.yaml","openAPI/user-forms.yaml","openAPI/user-tokens.yaml","openAPI/user-uploads-webhooks-added.yaml","openAPI/user-uploads-webhooks-ocr-authenticity.yaml","openAPI/user-uploads-webhooks-ocr-completed.yaml","openAPI/user-uploads-webhooks-ocr-failed.yaml","openAPI/user-uploads-webhooks-removed.yaml","openAPI/user-uploads.yaml","openAPI/users-webhooks.yaml","openAPI/users.yaml","openAPI/verifications-partners-webhooks-creation-failed.yaml","openAPI/verifications-partners-webhooks-connection-added.yaml","openAPI/verifications-partners-webhooks-connection-removed.yaml","openAPI/verifications-partners-webhooks-updated.yaml","openAPI/verifications-partners.yaml","openAPI/verifications-webhooks-creation-failed.yaml","openAPI/verifications-webhooks-connection-added.yaml","openAPI/verifications-webhooks-connection-removed.yaml","openAPI/verifications-webhooks-updated.yaml","openAPI/vehicles-webhooks-added.yaml","openAPI/vehicles-webhooks-removed.yaml","openAPI/vehicles-webhooks-updated.yaml","openAPI/vehicles.yaml","openAPI/verifications.yaml","openAPI/webhooks.yaml"],"mdx":{"server":["https://api-sandbox.argyle.com","https://api.argyle.com"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"https://console.argyle.com/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Contact sales","href":"https://argyle.com/contact-sales/"}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.argyle.com/images/social/argyle-docs.png","og:image:alt":"Argyle","twitter:image":"https://docs.argyle.com/images/social/argyle-docs.png","twitter:image:alt":"Argyle"}},"fonts":{"heading":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"},"body":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":{},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"argyle","hasAudioNarration":false,"actualSubdomain":"argyle","customDomains":["docs.argyle.com"],"gitSource":{"type":"github","owner":"argyle-systems","repo":"argyle-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb6a91c833ee61a251abd0","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Clients","count":216},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":51},{"language":"default","tag":"Partners","count":41},{"language":"default","tag":"Verifications","count":39},{"language":"default","tag":"Payroll Data Sets","count":24},{"language":"default","tag":"Core Resources","count":21},{"language":"default","tag":"Workflows","count":16},{"language":"default","tag":"Verticals","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/225e00a80fa65353/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/43713bf2b359289f/changelog.css"}],"page":{"pagePath":"api-reference/items","slug":"/api-reference/items","pageMetadata":{"openapi-schema":"openAPI/items.yaml Item","description":"Users connect their payroll accounts through **Items** in Link.","title":"Items","sidebarTitle":"Items","href":"/api-reference/items"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Users connect their payroll accounts through \", _jsx(_components.strong, {\n children: \"Items\"\n }), \" in Link.\"]\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`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Our `,_jsx(_components.a,{href:`/overview/data-structure/items`,children:`Items guide`}),` provides more information on how to retrieve:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Which data fields an Item supports, and how often an Item is re-scanned for new data.`}),`\n`,_jsxs(_components.li,{children:[`Whether an Item is `,_jsx(_components.code,{children:`healthy`}),` and supports new connections or is experiencing issues.`]}),`\n`,_jsx(_components.li,{children:`What data limits or other constraints the Item’s underlying payroll system has, if any.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`the-item-object`,children:`The Item object`})]})}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":{"codeStyling":{},"config":{},"pageMetadata":{"openapi-schema":"openAPI/items.yaml Item","description":"Users connect their payroll accounts through **Items** in Link.","title":"Items","sidebarTitle":"Items","href":"/api-reference/items"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"The Item object","slug":"the-item-object","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/argyle/af2164acf85a6b07/remove-image.js","/_mintlify/custom/argyle/0819c75d96f0177a/syntax-highlight.js","/_mintlify/custom/argyle/72285dbf6c5af137/legacy-hash-redirect.js","/_mintlify/custom/argyle/6e9f1651420bfe27/syntax-highlight-20260225.js","/_mintlify/custom/argyle/6c5de915fd850018/session-example-sync.js","/_mintlify/custom/argyle/74858b35daa8e825/audience-navigation.js","/_mintlify/custom/argyle/6e74c8b91218c4d2/audience-toggle.js","/_mintlify/custom/argyle/4b7ec966460f12b0/changelog-minisearch.js","/_mintlify/custom/argyle/cc05ec1a3c7e032f/changelog-navigation.js","/_mintlify/custom/argyle/77d8a125002fffa8/changelog-search.js","/_mintlify/custom/argyle/53f62f407a9be5ea/changelog-subscribe.js","/_mintlify/custom/argyle/ccdcfecc455cb06e/changelog-tags.js"],"openApiReferenceData":{"schemaData":{"type":"object","example":{"title":"Example","value":{"id":"item_000000001","name":"Whole Goods","kind":"employer","known_limitations":"First 5 digits of SSN obfuscated.","status":"healthy","status_details":null,"logo_url":"argyle.com/image-holdings","is_grouping":false,"mapping_status":"verified","features":{"data_retrieval":{"refresh_frequency":"5h"},"field_coverage":{"identities":{"first_name":{"supported":true},"last_name":{"supported":true},"...":{"supported":true}},"paystubs":{"hours_ytd":{"supported":false},"paystub_period":{"start_date":{"supported":true},"end_date":{"supported":true}},"...":{"supported":true}},"payroll_documents":{"...":{"supported":true}},"deposit_destinations":{"...":{"supported":true}},"shifts":{"...":{"supported":true}},"gigs":{"...":{"supported":true}},"vehicles":{"...":{"supported":true}},"ratings":{"...":{"supported":true}}},"deposit_destinations":{"max_observed_destinations":"2"},"direct_deposit_switch":{"card":{"supported":true,"max_allocations":"3"},"deposit_account":{"types":["ach_deposit_account"],"supported":true,"max_allocations":"2","amount_allocation":false,"percent_allocation":true,"amount_precision":null,"percent_precision":"0.01"}}}}},"properties":{"id":{"type":"string","description":"Unique ID of the Item. ID format — `item_123456789`\n","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Name of the Item.","uniqueKey":"name","typeLabel":"string"},"kind":{"type":"string","enum":["employer","gig","platform","benefits"],"description":"Type of Item.","uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"known_limitations":{"oneOf":[{"type":"string","description":"Known limitations of the Item, such as historical data limits, unique behavior, or degree of value obfuscation. Otherwise `null`.\n","uniqueKey":"known_limitations.oneOf.0","typeLabel":"string"},{"type":"null","description":"Known limitations of the Item, such as historical data limits, unique behavior, or degree of value obfuscation. Otherwise `null`.\n","uniqueKey":"known_limitations.oneOf.1","typeLabel":"null"}],"uniqueKey":"known_limitations","typeLabel":"string | null"},"status":{"type":"string","enum":["healthy","issues","unavailable"],"description":"Health status of the Item.\n\n- `healthy` — Normal service.\n- `issues` — Impacted service. New account connections still supported.\n- `unavailable` — Impacted service. New account connections not supported. [Ongoing refresh](/overview/ongoing-refresh) paused.\n","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_details":{"oneOf":[{"type":"string","description":"Additional details on the Item's health status, such as degraded account connection ability or paused [ongoing refresh](/overview/ongoing-refresh). Otherwise `null`.\n","uniqueKey":"status_details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional details on the Item's health status, such as degraded account connection ability or paused [ongoing refresh](/overview/ongoing-refresh). Otherwise `null`.\n","uniqueKey":"status_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_details","typeLabel":"string | null"},"logo_url":{"type":"string","description":"URL location of the Item's logo image file.","uniqueKey":"logo_url","typeLabel":"string"},"is_grouping":{"type":"boolean","description":"`true` if the Item does not directly support account connections, but instead acts as a container for other Items.\n","uniqueKey":"is_grouping","typeLabel":"boolean"},"mapping_status":{"type":"string","enum":["verified","mapped","unmapped"],"description":"Verification status of the Item.\n\n- `verified` — The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data.\n- `mapped` — The payroll system associated with the Item is known, but the Item is awaiting a successful connection.\n- `unmapped` — The payroll system associated with this Item is not yet known. If an `unmapped` Item is selected in Link, the user will be given the option to search for the relevant payroll system and attempt to connect using their login credentials.\n","uniqueKey":"mapping_status","typeLabel":"enum\u003cstring>"},"matching_score":{"type":"string","description":"Confidence score based on the degree of similarity between the Item and the search term. Ranges from \"1.00\" (strong match) to \"0.01\" (weak match).\n\n`matching_score` is only returned when [listing Items](/api-reference/items#list) and is only applicable when the `q` \"free-text search\" [query parameter](/api-reference/items#list-q) is used.\n\nReturned as a decimal string with exactly two decimal places.\n","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"matching_score","typeLabel":"string"},"features":{"type":"object","description":"What data fields the Item supports, the Item's deposit switching capabilities, and how often the Item is refreshed with new data.\n\n*Only returned when* [retrieving individual Items](/api-reference/items#retrieve) *by Item ID.*\n","properties":{"data_retrieval":{"type":"object","description":"Details on how often the Item is re-scanned for new data.","properties":{"refresh_frequency":{"type":"string","description":"How often the Item is re-scanned to check for new data, which is used to update all accounts connected to this Item.\n\nRounded up to the nearest hour, in the format `#hr`.\n\n*`null` values indicate [ongoing data refreshes](/overview/ongoing-refresh) have temporarily been suspended. Check the Item's health [status](#object-status) and [status_details](#object-status_details) for more information.*\n","uniqueKey":"features.data_retrieval.refresh_frequency","typeLabel":"string"}},"uniqueKey":"features.data_retrieval","typeLabel":"object"},"field_coverage":{"type":"object","description":"Contains information on whether the Item returns data for a particular property within one of Argyle's data sets.\n\n*Does not include object ID's, account ID's, or metadata. `null` values are returned for properties of new or uncommon Items until a determination on data availability can be made.*\n","properties":{"identities":{"type":"object","description":"All data fields of the [identity object](/api-reference/identities#object).","uniqueKey":"features.field_coverage.identities","typeLabel":"object"},"paystubs":{"type":"object","description":"All data fields of the [paystub object](/api-reference/paystubs#object).","uniqueKey":"features.field_coverage.paystubs","typeLabel":"object"},"payroll_documents":{"type":"object","description":"All data fields of the [payroll document object](/api-reference/payroll-documents#object).","uniqueKey":"features.field_coverage.payroll_documents","typeLabel":"object"},"deposit_destinations":{"type":"object","description":"All data fields of the [deposit destination object](/api-reference/deposit-destinations#object).","uniqueKey":"features.field_coverage.deposit_destinations","typeLabel":"object"},"shifts":{"type":"object","description":"All data fields of the [shift object](/api-reference/shifts#object).","uniqueKey":"features.field_coverage.shifts","typeLabel":"object"},"gigs":{"type":"object","description":"All data fields of the [gig object](/api-reference/gigs#object).","uniqueKey":"features.field_coverage.gigs","typeLabel":"object"},"vehicles":{"type":"object","description":"All data fields of the [vehicle object](/api-reference/vehicles#object).","uniqueKey":"features.field_coverage.vehicles","typeLabel":"object"},"ratings":{"type":"object","description":"All data fields of the [rating object](/api-reference/ratings#object).","uniqueKey":"features.field_coverage.ratings","typeLabel":"object"}},"uniqueKey":"features.field_coverage","typeLabel":"object"},"deposit_destinations":{"type":"object","properties":{"max_observed_destinations":{"oneOf":[{"type":"string","description":"The highest number of deposit destinations observed on a connected account for the Item. This value updates when a higher number is observed and is returned as a numeric string when available.","uniqueKey":"features.deposit_destinations.max_observed_destinations.oneOf.0","typeLabel":"string"},{"type":"null","description":"The highest number of deposit destinations observed on a connected account for the Item. This value updates when a higher number is observed and is returned as a numeric string when available.","uniqueKey":"features.deposit_destinations.max_observed_destinations.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.deposit_destinations.max_observed_destinations","typeLabel":"string | null"}},"uniqueKey":"features.deposit_destinations","typeLabel":"object"},"direct_deposit_switch":{"type":"object","description":"Contains information on the Item's deposit switch capabilities.","properties":{"card":{"type":"object","description":"Employer supports payouts to debit cards.","properties":{"supported":{"type":"boolean","description":"`true` if the Item supports payouts to debit cards.\n\nGenerally applies to gig platforms, where users can send instant payouts to debit cards.\n","uniqueKey":"features.direct_deposit_switch.card.supported","typeLabel":"boolean"},"max_allocations":{"type":"string","format":"integer","description":"Number of debit cards that can be added to the Item's underlying platform.","uniqueKey":"features.direct_deposit_switch.card.max_allocations","typeLabel":"string\u003cinteger>"}},"uniqueKey":"features.direct_deposit_switch.card","typeLabel":"object"},"deposit_account":{"type":"object","description":"Direct deposit capabilities.","properties":{"types":{"type":"array","items":{"type":"string","uniqueKey":"features.direct_deposit_switch.deposit_account.types.items.[INDEX]","typeLabel":"string"},"description":"The types of bank accounts supported.\n\nOnly `ach_deposit_account` (U.S. deposit account) is currently supported.\n","uniqueKey":"features.direct_deposit_switch.deposit_account.types","typeLabel":"string[]"},"supported":{"type":"boolean","description":"`true` if the Item supports deposit switching.","uniqueKey":"features.direct_deposit_switch.deposit_account.supported","typeLabel":"boolean"},"max_allocations":{"type":"string","format":"integer","description":"Number of total bank accounts supported by the Item's underlying platform.","uniqueKey":"features.direct_deposit_switch.deposit_account.max_allocations","typeLabel":"string\u003cinteger>"},"amount_allocation":{"type":"boolean","description":"`true` if the Item's direct deposit settings support using exact amounts to define how pay is allocated to different bank accounts.","uniqueKey":"features.direct_deposit_switch.deposit_account.amount_allocation","typeLabel":"boolean"},"percent_allocation":{"type":"boolean","description":"`true` if the Item's direct deposit settings support using exact percentages of total pay to define how pay is allocated to different bank accounts.","uniqueKey":"features.direct_deposit_switch.deposit_account.percent_allocation","typeLabel":"boolean"},"amount_precision":{"oneOf":[{"type":"string","description":"What level of precision is allowed when setting amount allocations.\n\n- `100`\n- `10`\n- `1` — e.g. $52 or $53\n- `0.10`\n- `0.01` — e.g. $52.05 or $52.06\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n","uniqueKey":"features.direct_deposit_switch.deposit_account.amount_precision.oneOf.0","typeLabel":"string"},{"type":"null","description":"What level of precision is allowed when setting amount allocations.\n\n- `100`\n- `10`\n- `1` — e.g. $52 or $53\n- `0.10`\n- `0.01` — e.g. $52.05 or $52.06\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n","uniqueKey":"features.direct_deposit_switch.deposit_account.amount_precision.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.direct_deposit_switch.deposit_account.amount_precision","typeLabel":"string | null"},"percent_precision":{"oneOf":[{"type":"string","description":"What level of precision is allowed when setting percentage allocations.\n\n- `100`\n- `10`\n- `1` — e.g. 52% or 53%\n- `0.10`\n- `0.01` — e.g. 52.05% or 52.06%\n- `0.001`\n- `0.0001`\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n","uniqueKey":"features.direct_deposit_switch.deposit_account.percent_precision.oneOf.0","typeLabel":"string"},{"type":"null","description":"What level of precision is allowed when setting percentage allocations.\n\n- `100`\n- `10`\n- `1` — e.g. 52% or 53%\n- `0.10`\n- `0.01` — e.g. 52.05% or 52.06%\n- `0.001`\n- `0.0001`\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n","uniqueKey":"features.direct_deposit_switch.deposit_account.percent_precision.oneOf.1","typeLabel":"null"}],"uniqueKey":"features.direct_deposit_switch.deposit_account.percent_precision","typeLabel":"string | null"}},"uniqueKey":"features.direct_deposit_switch.deposit_account","typeLabel":"object"}},"uniqueKey":"features.direct_deposit_switch","typeLabel":"object"}},"uniqueKey":"features","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"openAPI/items.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Items - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-08T20:48:45.674Z","originalFileLocation":"api-reference/items.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=\"light\"}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=\"Users connect their payroll accounts through Items in Link.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_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/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Items - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Users connect their payroll accounts through Items in Link.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Argyle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.argyle.com/api-reference/items\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\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=\"Items - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Users connect their payroll accounts through Items in Link.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\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/argyle/cbIyejDMMl6E05gL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#214E48\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Argyle\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Argyle\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.argyle.com/api-reference/items\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/items.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.argyle.com/#organization\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.argyle.com#website\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.argyle.com/api-reference/items#webpage\",\"url\":\"https://docs.argyle.com/api-reference/items\",\"name\":\"Items\",\"description\":\"Users connect their payroll accounts through Items in Link.\",\"dateModified\":\"2026-04-08T20:48:45.674Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/items#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/items#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Argyle Docs\",\"item\":\"https://docs.argyle.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Items\",\"item\":\"https://docs.argyle.com/api-reference/items\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/items#apireference\",\"headline\":\"Items\",\"name\":\"Items\",\"description\":\"Users connect their payroll accounts through Items in Link.\",\"url\":\"https://docs.argyle.com/api-reference/items\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/items#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-04-08T20:48:45.674Z\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/items.md","siteName":"Argyle Docs","nav":{"global":null,"products":[{"product":"Clients","icon":"building","description":"Build for your organization.","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Verticals","pages":[{"title":"Verticals","href":"/verticals"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"group":"Verifications","pages":[{"group":"Verifications","pages":[{"openapi":"openAPI/verifications.yaml post /v2/verifications","title":"Order a verification","sidebarTitle":"Order a verification","href":"/api-reference/verifications/order-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/sessions","title":"Create a session","sidebarTitle":"Create a session","href":"/api-reference/verifications/create-a-session"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/refresh","title":"Refresh a verification","sidebarTitle":"Refresh a verification","href":"/api-reference/verifications/refresh-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications/{id}","title":"Retrieve a verification","sidebarTitle":"Retrieve a verification","href":"/api-reference/verifications/retrieve-a-verification"},{"openapi":"openAPI/verifications.yaml patch /v2/verifications/{id}","title":"Update a verification","sidebarTitle":"Update a verification","href":"/api-reference/verifications/update-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/{id}/cancel","title":"Cancel a verification","sidebarTitle":"Cancel a verification","href":"/api-reference/verifications/cancel-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications","title":"List all verifications","sidebarTitle":"List all verifications","href":"/api-reference/verifications/list-all-verifications"}]}]},{"group":"Core Resources","pages":[{"group":"Users","pages":[{"title":"Users","sidebarTitle":"Users","href":"/api-reference/users"},{"title":"Create A User","openapi":"post /v2/users","href":"/api-reference/users/create-a-user"},{"title":"Retrieve A User","openapi":"get /v2/users/{id}","href":"/api-reference/users/retrieve-a-user"},{"title":"Update A User","openapi":"patch /v2/users/{id}","href":"/api-reference/users/update-a-user"},{"title":"Delete A User","openapi":"delete /v2/users/{id}","href":"/api-reference/users/delete-a-user"},{"title":"List All Users","openapi":"get /v2/users","href":"/api-reference/users/list-all-users"}]},{"group":"User Tokens","pages":[{"title":"User Tokens","href":"/api-reference/user-tokens"},{"title":"Create A User Token","openapi":"post /v2/user-tokens","href":"/api-reference/user-tokens/create-a-user-token"}]},{"group":"Invites","pages":[{"title":"Invites","sidebarTitle":"Invites","href":"/api-reference/invites"},{"title":"Send An Invite","openapi":"post /v2/invites","href":"/api-reference/invites/send-an-invite"},{"title":"Retrieve An Invite","openapi":"get /v2/invites/{id}","href":"/api-reference/invites/retrieve-an-invite"},{"title":"Re-send an invite","openapi":"post /v2/invites/{id}","href":"/api-reference/invites/re-send-an-invite"},{"title":"Revoke An Invite","openapi":"post /v2/invites/{id}/revoke","href":"/api-reference/invites/revoke-an-invite"},{"title":"List All Invites","openapi":"get /v2/invites","href":"/api-reference/invites/list-all-invites"}]},{"group":"Accounts","pages":[{"title":"Accounts","sidebarTitle":"Accounts","href":"/api-reference/accounts"},{"title":"Retrieve An Account","openapi":"openAPI/accounts.yaml get /v2/accounts/{id}","href":"/api-reference/accounts/retrieve-an-account"},{"title":"Delete An Account","openapi":"openAPI/accounts.yaml delete /v2/accounts/{id}","href":"/api-reference/accounts/delete-an-account"},{"title":"List All Accounts","openapi":"openAPI/accounts.yaml get /v2/accounts","href":"/api-reference/accounts/list-all-accounts"},{"title":"Disable Account Updates","openapi":"openAPI/accounts.yaml post /v2/accounts/{id}/disable-ongoing-refresh","href":"/api-reference/accounts/disable-account-updates"}]},{"group":"Employments","pages":[{"title":"Employments","sidebarTitle":"Employments","href":"/api-reference/employments"},{"title":"List All Employments","openapi":"get /v2/employments","description":"Returns a paginated list of all employment objects.","href":"/api-reference/employments/list-all-employments"}]}]},{"group":"Coverage","pages":[{"group":"Items","pages":[{"title":"Items","sidebarTitle":"Items","href":"/api-reference/items"},{"title":"Retrieve An Item","description":"Retrieves an Item object.\n","openapi":"get /v2/items/{id}","href":"/api-reference/items/retrieve-an-item"},{"title":"List All Items","openapi":"get /v2/items","href":"/api-reference/items/list-all-items"},{"title":"Migrate a Link Item ID","openapi":"post /v2/item-migrations","href":"/api-reference/items/migrate-a-link-item-id"}]},{"group":"Item Filters","pages":[{"title":"Item Filters","sidebarTitle":"Item Filters","href":"/api-reference/item-filters"},{"title":"Create An Item Filter","openapi":"post /v2/item-filters","href":"/api-reference/item-filters/create-an-item-filter"},{"title":"Retrieve An Item Filter","openapi":"get /v2/item-filters/{id}","href":"/api-reference/item-filters/retrieve-an-item-filter"},{"title":"Replace An Item Filter","openapi":"put /v2/item-filters/{id}","href":"/api-reference/item-filters/replace-an-item-filter"},{"title":"Delete An Item Filter","openapi":"delete /v2/item-filters/{id}","href":"/api-reference/item-filters/delete-an-item-filter"},{"title":"List All Item Filters","openapi":"get /v2/item-filters","href":"/api-reference/item-filters/list-all-item-filters"}]},{"group":"Employer Search","pages":[{"title":"Employer Search","sidebarTitle":"Employer Search","href":"/api-reference/employer-search"},{"title":"List All Employers","openapi":"get /v2/employer-search","href":"/api-reference/employer-search/list-all-employers"}]}]},{"group":"Payroll Data Sets","pages":[{"group":"Identities","pages":[{"title":"Identities","sidebarTitle":"Identities","href":"/api-reference/identities"},{"title":"Retrieve An Identity","openapi":"get /v2/identities/{id}","href":"/api-reference/identities/retrieve-an-identity"},{"title":"List All Identities","openapi":"get /v2/identities","href":"/api-reference/identities/list-all-identities"}]},{"group":"Paystubs","pages":[{"title":"Paystubs","sidebarTitle":"Paystubs","href":"/api-reference/paystubs"},{"title":"Retrieve A Paystub","openapi":"get /v2/paystubs/{id}","href":"/api-reference/paystubs/retrieve-a-paystub"},{"title":"List All Paystubs","openapi":"get /v2/paystubs","href":"/api-reference/paystubs/list-all-paystubs"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents","sidebarTitle":"Payroll Documents","href":"/api-reference/payroll-documents"},{"title":"Retrieve A Payroll Document","openapi":"get /v2/payroll-documents/{id}","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"},{"title":"List All Payroll Documents","openapi":"get /v2/payroll-documents","href":"/api-reference/payroll-documents/list-all-payroll-documents"}]},{"group":"Deposit Destinations","pages":[{"title":"Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/deposit-destinations"},{"title":"Retrieve A Deposit Destination","openapi":"get /v2/deposit-destinations/{id}","href":"/api-reference/deposit-destinations/retrieve-a-deposit-destination"},{"title":"List All Deposit Destinations","openapi":"get /v2/deposit-destinations","href":"/api-reference/deposit-destinations/list-all-deposit-destinations"}]},{"group":"Shifts","pages":[{"title":"Shifts","sidebarTitle":"Shifts","href":"/api-reference/shifts"},{"title":"Retrieve A Shift","openapi":"get /v2/shifts/{id}","href":"/api-reference/shifts/retrieve-a-shift"},{"title":"List All Shifts","openapi":"get /v2/shifts","href":"/api-reference/shifts/list-all-shifts"}]},{"group":"Gigs","pages":[{"title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"},{"title":"Retrieve A Gig","openapi":"get /v2/gigs/{id}","href":"/api-reference/gigs/retrieve-a-gig"},{"title":"List All Gigs","openapi":"get /v2/gigs","href":"/api-reference/gigs/list-all-gigs"}]},{"group":"Vehicles","pages":[{"title":"Vehicles","sidebarTitle":"Vehicles","href":"/api-reference/vehicles"},{"title":"Retrieve A Vehicle","openapi":"get /v2/vehicles/{id}","href":"/api-reference/vehicles/retrieve-a-vehicle"},{"title":"List All Vehicles","openapi":"get /v2/vehicles","href":"/api-reference/vehicles/list-all-vehicles"}]},{"group":"Ratings","pages":[{"title":"Ratings","sidebarTitle":"Ratings","href":"/api-reference/ratings"},{"title":"Retrieve A Rating","openapi":"get /v2/ratings/{id}","href":"/api-reference/ratings/retrieve-a-rating"},{"title":"List All Ratings","openapi":"get /v2/ratings","href":"/api-reference/ratings/list-all-ratings"}]}]},{"group":"Banking","pages":[{"group":"Financial Institutions","pages":[{"title":"Financial Institutions","sidebarTitle":"Financial Institutions","href":"/api-reference/financial-institutions"},{"openapi":"get /v2/open-banking/institutions/{institution_id}","title":"Retrieve an institution","href":"/api-reference/financial-institutions/retrieve-an-institution"},{"openapi":"get /v2/open-banking/institutions","title":"List all institutions","href":"/api-reference/financial-institutions/list-all-institutions"}]},{"group":"Bank Accounts","pages":[{"title":"Bank Accounts","sidebarTitle":"Bank Accounts","href":"/api-reference/bank-accounts"},{"openapi":"get /v2/open-banking/bank-accounts/{bank_account_id}","title":"Retrieve a bank account","href":"/api-reference/bank-accounts/retrieve-a-bank-account"},{"openapi":"get /v2/open-banking/bank-accounts","title":"List all bank accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts"}]}]},{"group":"Reports","pages":[{"group":"Reports","pages":[{"title":"Reports","sidebarTitle":"Reports","href":"/api-reference/reports"},{"title":"List All Reports","openapi":"get /v2/reports","href":"/api-reference/reports/list-all-reports"},{"title":"Generate A Report","openapi":"post /v2/reports/{type}","href":"/api-reference/reports/generate-a-report"},{"title":"Retrieve A Report","openapi":"get /v2/reports/{id}","href":"/api-reference/reports/retrieve-a-report"},{"title":"Delete A Report","openapi":"delete /v2/reports/{id}","href":"/api-reference/reports/delete-a-report"}]}]},{"group":"Workflows","pages":[{"group":"User Uploads","pages":[{"title":"User Uploads","sidebarTitle":"User Uploads","href":"/api-reference/user-uploads"},{"title":"Upload A Document","openapi":"post /v2/user-uploads","href":"/api-reference/user-uploads/upload-a-document"},{"title":"Retrieve A User Upload","openapi":"get /v2/user-uploads/{id}","href":"/api-reference/user-uploads/retrieve-a-user-upload"},{"title":"List All User Uploads","openapi":"get /v2/user-uploads","href":"/api-reference/user-uploads/list-all-user-uploads"}]},{"group":"User Forms","pages":[{"title":"User Forms","sidebarTitle":"User Forms","href":"/api-reference/user-forms"},{"title":"Retrieve A User Form","openapi":"get /v2/user-forms/{id}","href":"/api-reference/user-forms/retrieve-a-user-form"},{"title":"List All User Forms","openapi":"get /v2/user-forms","href":"/api-reference/user-forms/list-all-user-forms"}]},{"group":"Legacy Workflows","pages":[{"title":"Document Verifications","sidebarTitle":"Legacy Documents","href":"/api-reference/documents-overview"},{"group":"Legacy Banking","pages":[{"title":"Banking Overview Guide","sidebarTitle":"Overview Guide","href":"/api-reference/banking-overview"},{"group":"Connect URL","pages":[{"title":"Connect URL","openapi":"openAPI/open-banking.yaml post /v2/open-banking/connect","href":"/api-reference/connect-url"},{"openapi":"post /v2/open-banking/connect","title":"Create a Connect URL","href":"/api-reference/connect-url/create-a-connect-url"}]},{"group":"Banking Reports","pages":[{"title":"Banking Reports","href":"/api-reference/banking-reports"},{"openapi":"post /v2/open-banking/reports/{type}","title":"Generate a banking report","href":"/api-reference/banking-reports/generate-a-banking-report"}]}]}]}]},{"group":"Webhooks","pages":[{"group":"Users","pages":[{"title":"Users.fully_synced webhook","openapi":"openAPI/users-webhooks.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/users-webhooks/fully-synced"}]},{"group":"Accounts","pages":[{"title":"Accounts.added webhook","openapi":"openAPI/account-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/accounts-webhooks/added"},{"title":"Accounts.updated webhook","openapi":"openAPI/account-webhook-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/accounts-webhooks/updated"},{"title":"Accounts.removed webhook","openapi":"openAPI/accounts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/accounts-webhooks/removed"},{"title":"Accounts.connected webhook","openapi":"openAPI/accounts-webhooks-connected.yaml post /v2/webhooks","sidebarTitle":"Connected","href":"/api-reference/accounts-webhooks/connected"},{"title":"Accounts.failed webhook","openapi":"openAPI/accounts-webhooks-failed.yaml post /v2/webhooks","sidebarTitle":"Failed","href":"/api-reference/accounts-webhooks/failed"}]},{"group":"Items","pages":[{"title":"Items.updated webhook","openapi":"openAPI/items-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/items-webhooks/updated"},{"title":"Items.removed webhook","openapi":"openAPI/items-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/items-webhooks/removed"}]},{"group":"Identities","pages":[{"title":"Identities.added webhook","openapi":"openAPI/identities-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/identities-webhooks/added"},{"title":"Identities.updated webhook","openapi":"openAPI/identities-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/identities-webhooks/updated"}]},{"group":"Paystubs","pages":[{"title":"Paystubs.added webhook","openapi":"openAPI/paystubs-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/paystubs-webhooks/added"},{"title":"Paystubs.updated webhook","openapi":"openAPI/paystubs-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/paystubs-webhooks/updated"},{"title":"Paystubs.partially_synced webhook","openapi":"openAPI/paystubs-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/paystubs-webhooks/partially-synced"},{"title":"Paystubs.fully_synced webhook","openapi":"openAPI/paystubs-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/paystubs-webhooks/fully-synced"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents.added webhook","openapi":"openAPI/payroll-documents-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/payroll-documents-webhooks/added"},{"title":"Payroll Documents.updated webhook","openapi":"openAPI/payroll-documents-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/payroll-documents-webhooks/updated"},{"title":"Payroll Documents.removed webhook","openapi":"openAPI/payroll-documents-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/payroll-documents-webhooks/removed"},{"title":"Payroll Documents.ocr_completed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-completed.yaml post /v2/webhooks","sidebarTitle":"OCR completed","href":"/api-reference/payroll-documents-webhooks/ocr-completed"},{"title":"Payroll Documents.ocr_failed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-failed.yaml post /v2/webhooks","sidebarTitle":"OCR failed","href":"/api-reference/payroll-documents-webhooks/ocr-failed"}]},{"group":"Shifts","pages":[{"title":"Shifts.added webhook","openapi":"openAPI/shifts-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/shifts-webhooks/added"},{"title":"Shifts.updated webhook","openapi":"openAPI/shifts-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/shifts-webhooks/updated"},{"title":"Shifts.removed webhook","openapi":"openAPI/shifts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/shifts-webhooks/removed"},{"title":"Shifts.partially_synced webhook","openapi":"openAPI/shifts-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/shifts-webhooks/partially-synced"},{"title":"Shifts.fully_synced webhook","openapi":"openAPI/shifts-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/shifts-webhooks/fully-synced"}]},{"group":"Gigs","pages":[{"openapi":"openAPI/gigs-webhooks-added.yaml post /v2/webhooks","title":"Gigs.added webhook","sidebarTitle":"Added","href":"/api-reference/gigs-webhooks/added"},{"openapi":"openAPI/gigs-webhooks-updated.yaml post /v2/webhooks","title":"Gigs.updated webhook","sidebarTitle":"Updated","href":"/api-reference/gigs-webhooks/updated"},{"openapi":"openAPI/gigs-webhooks-removed.yaml post /v2/webhooks","title":"Gigs.removed webhook","sidebarTitle":"Removed","href":"/api-reference/gigs-webhooks/removed"},{"openapi":"openAPI/gigs-webhooks-partially-synced.yaml post /v2/webhooks","title":"Gigs.partially_synced webhook","sidebarTitle":"Partially synced","href":"/api-reference/gigs-webhooks/partially-synced"},{"openapi":"openAPI/gigs-webhooks-fully-synced.yaml post /v2/webhooks","title":"Gigs.fully_synced webhook","sidebarTitle":"Fully synced","href":"/api-reference/gigs-webhooks/fully-synced"}]},{"group":"Vehicles","pages":[{"openapi":"openAPI/vehicles-webhooks-added.yaml post /v2/webhooks","title":"Vehicles.added webhook","sidebarTitle":"Added","href":"/api-reference/vehicles-webhooks/added"},{"openapi":"openAPI/vehicles-webhooks-updated.yaml post /v2/webhooks","title":"Vehicles.updated webhook","sidebarTitle":"Updated","href":"/api-reference/vehicles-webhooks/updated"},{"openapi":"openAPI/vehicles-webhooks-removed.yaml post /v2/webhooks","title":"Vehicles.removed webhook","sidebarTitle":"Removed","href":"/api-reference/vehicles-webhooks/removed"}]},{"group":"Ratings","pages":[{"openapi":"openAPI/ratings-webhooks-added.yaml post /v2/webhooks","title":"Ratings.added webhook","sidebarTitle":"Added","href":"/api-reference/ratings-webhooks/added"},{"openapi":"openAPI/ratings-webhooks-updated.yaml post /v2/webhooks","title":"Ratings.updated webhook","sidebarTitle":"Updated","href":"/api-reference/ratings-webhooks/updated"}]},{"group":"Reports","pages":[{"openapi":"openAPI/reports-webhooks-ready.yaml post /v2/webhooks","title":"Reports.ready webhook","sidebarTitle":"Ready","href":"/api-reference/reports-webhooks/ready"},{"openapi":"openAPI/reports-webhooks-generated.yaml post /v2/webhooks","title":"Reports.generated webhook","sidebarTitle":"Generated","href":"/api-reference/reports-webhooks/generated"}]},{"group":"User Uploads","pages":[{"openapi":"openAPI/user-uploads-webhooks-added.yaml post /v2/webhooks","title":"User Uploads.added webhook","sidebarTitle":"Added","href":"/api-reference/user-uploads-webhooks/added"},{"openapi":"openAPI/user-uploads-webhooks-removed.yaml post /v2/webhooks","title":"User Uploads.removed webhook","sidebarTitle":"Removed","href":"/api-reference/user-uploads-webhooks/removed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-completed.yaml post /v2/webhooks","title":"User Uploads.ocr_completed webhook","sidebarTitle":"OCR Completed","href":"/api-reference/user-uploads-webhooks/ocr-completed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-failed.yaml post /v2/webhooks","title":"User Uploads.ocr_failed webhook","sidebarTitle":"OCR Failed","href":"/api-reference/user-uploads-webhooks/ocr-failed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-authenticity.yaml post /v2/webhooks","title":"User Uploads.ocr_authenticity webhook","sidebarTitle":"OCR Authenticity","href":"/api-reference/user-uploads-webhooks/ocr-authenticity"}]},{"group":"User Forms","pages":[{"title":"User Forms.submitted webhook","openapi":"openAPI/user-forms-webhooks.yaml post /v2/webhooks","sidebarTitle":"Submitted","href":"/api-reference/user-forms-webhooks/user-forms-submitted"},{"title":"User Forms.removed webhook","openapi":"openAPI/user-forms-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/user-forms-webhooks/user-forms-removed"}]},{"group":"Verifications","pages":[{"title":"Verifications.updated webhook","openapi":"openAPI/verifications-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/verifications-webhooks/updated"},{"title":"Verifications.creation_failed webhook","openapi":"openAPI/verifications-webhooks-creation-failed.yaml post /v2/webhooks","sidebarTitle":"Creation failed","href":"/api-reference/verifications-webhooks/creation-failed"},{"title":"Verifications.connection_added webhook","openapi":"openAPI/verifications-webhooks-connection-added.yaml post /v2/webhooks","sidebarTitle":"Connection added","href":"/api-reference/verifications-webhooks/connection-added"},{"title":"Verifications.connection_removed webhook","openapi":"openAPI/verifications-webhooks-connection-removed.yaml post /v2/webhooks","sidebarTitle":"Connection removed","href":"/api-reference/verifications-webhooks/connection-removed"}]},{"group":"Webhook management","pages":[{"title":"Create a webhook","openapi":"openAPI/webhooks.yaml post /v2/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Retrieve a webhook","openapi":"openAPI/webhooks.yaml get /v2/webhooks/{id}","href":"/api-reference/webhooks/retrieve-a-webhook"},{"title":"Delete a webhook","openapi":"openAPI/webhooks.yaml delete /v2/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List all webhooks","openapi":"openAPI/webhooks.yaml get /v2/webhooks","href":"/api-reference/webhooks/list-all-webhooks"}]}]},{"group":"Receipts","pages":[{"group":"Receipts","pages":[{"openapi":"post /v2/receipts","title":"Receipts","href":"/api-reference/receipts"}]}]},{"group":"Error Codes","pages":[{"title":"Account Connection Errors","sidebarTitle":"Account Connection Errors","href":"/api-reference/account-connection-errors"},{"title":"Bank Connection Errors","sidebarTitle":"Bank Connection Errors","href":"/api-reference/bank-connection-errors"}]}]}]},{"product":"Partners","icon":"puzzle-piece","description":"Build for your customers.","pages":[{"title":"Partners","href":"/partners"}]},{"product":"Changelog","description":"Product updates and announcements","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Items - Argyle Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}