Note:
When task_count is greater than 1 (e.g. two pickups in one delivery), the gig object contains aggregated values for the entire gig assignment. Individual task-level details can be found in the task_details object.
Amount earned by the gig employee per hour or per mile.
Note:
Values are not calculated, and are only returned if directly provided by the gig platform.
Show child attributes
{"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-updated.yaml","openAPI/verifications-partners.yaml","openAPI/verifications-webhooks-creation-failed.yaml","openAPI/verifications-webhooks-connection-added.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":""},"chroma":{"liveDeploymentHistoryId":"6ae4fd88cb9ad1a9b1c3f478","collectionId":"5a12f5b7-9162-46be-9b9e-7873250cf9ea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4fd88cb9ad1a9b1c3f478"},"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":"6ae4fd88cb9ad1a9b1c3f478","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Clients","count":215},{"language":"default","tag":"API Reference","count":169},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":50},{"language":"default","tag":"Partners","count":40},{"language":"default","tag":"Verifications","count":38},{"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":"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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/c71dc7693384de52/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/81c93b48daa6fd82/changelog.css"}],"page":{"pagePath":"api-reference/gigs","slug":"/api-reference/gigs","pageMetadata":{"openapi-schema":"Gig","description":"Retrieve information specific to gig employments.","title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"},"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: \"Retrieve information specific to gig employments.\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const{Heading}={..._provideComponents(),...props.components};if(!Heading)_missingMdxReference(`Heading`,true);return _jsx(Heading,{level:`2`,id:`the-gig-object`,children:`The gig 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":"Gig","description":"Retrieve information specific to gig employments.","title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"The gig object","slug":"the-gig-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/58987997dede87ed/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":"0187dbfa-6f5e-a33a-af26-7e12ff408fea","account":"0187c66e-e7e5-811c-b006-2232f00f426a","employer":"GigAndGo","created_at":"2023-03-08T08:31:37.037Z","updated_at":"2023-03-08T08:31:37.037Z","status":"completed","type":"delivery","task_count":2,"start_datetime":"2023-03-08T08:08:57Z","end_datetime":"2023-03-08T08:31:36Z","all_datetimes":{"request_at":"2023-03-08T08:08:57Z","accept_at":"2023-03-08T08:09:38Z","pickup_at":"2023-03-08T08:12:57Z","dropoff_at":"2023-03-08T08:31:36Z","cancel_at":null,"shift_start":null,"shift_end":null,"breaks":null},"duration":2659,"timezone":"America/New_York","earning_type":"work","start_location":{"lat":"40.65932120164202","lng":"-73.8526246331782","formatted_address":"201 North W St, New York, NY 10014, US"},"end_location":{"lat":"40.689177462234504","lng":"-73.89453884284752","formatted_address":"102 South E St, New York, NY 10002, US"},"task_details":{"events":[{"order_id":null,"sequence":"1","type":"accept","name":null,"formatted_address":"201 North W St, New York, NY 10014, US","lat":"40.65932120164202","lng":"-73.89453884284752","datetime":"2023-03-08T08:09:38Z"},{"order_id":"1","sequence":"2","type":"pickup","name":"Healthy Snacks","formatted_address":"150 East N St, New York, NY 10014, US","lat":"40.673422892136178","lng":"-73.88931269893891","datetime":"2023-03-08T08:12:57Z"},{"order_id":"2","sequence":"3","type":"pickup","name":"Gourmet Desserts","formatted_address":"182 East N St, New York, NY 10014, US","lat":"40.673523811763259","lng":"-73.86335212657626","datetime":"2023-03-08T08:12:57Z"},{"order_id":null,"sequence":"4","type":"dropoff","name":null,"formatted_address":"102 South E St, New York, NY 10002, US","lat":"40.689177462234504","lng":"-73.89453884284752","datetime":"2023-03-08T08:31:36Z"}],"orders":[{"order_id":"1","sequence":"1","income":{"currency":"USD","total_charge":"34.75","customer_price":"26.38","fees":"8.37","total":"19.96","pay":"22.28","tips":null,"bonus":"0.00","other":"-2.32"}},{"order_id":"2","sequence":"2","income":{"currency":"USD","total_charge":"7.25","customer_price":"7.25","fees":null,"total":"4.30","pay":"4.30","tips":"0.00","bonus":"0.00","other":null}}]},"distance":"1.80","distance_unit":"miles","metadata":{"income.other":{"name":"Taxes: Withholding tax","value":"-15.32"}},"circumstances":{"is_pool":false,"is_rush":false,"is_surge":true,"service_type":"Comfort Ride","position":null},"income":{"currency":"USD","total_charge":"42.00","customer_price":"33.68","fees":"8.37","total":"30.68","pay":"26.58","tips":"6.42","bonus":"0.00","other":"-2.32"},"income_rates":{"hour":"92.70","mile":"20.20"}}},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the gig assignment.","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"account":{"type":"string","format":"uuid","description":"Unique ID of the account associated with the gig assignment.","uniqueKey":"account","typeLabel":"string\u003cuuid>"},"employer":{"type":"string","description":"Employer name.","uniqueKey":"employer","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig object was created.\n","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when a property value of the gig object most recently changed.\n","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["scheduled","in_progress","completed","cancelled"],"description":"Current state of the gig assignment.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["delivery","rideshare","hourly","services"],"description":"The type of gig assignment.","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"task_count":{"type":"integer","description":"Number of discrete tasks in the gig assignment.\n\n**Note:**\nWhen `task_count` is greater than 1 (e.g. two pickups in one delivery), the gig object contains aggregated values for the entire gig assignment. Individual task-level details can be found in the [`task_details`](https://docs.argyle.com/api-reference/gigs#object-task_details) object.\n","uniqueKey":"task_count","typeLabel":"integer"},"start_datetime":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig assignment started.\n","uniqueKey":"start_datetime","typeLabel":"string\u003cdate-time>"},"end_datetime":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig assignment ended.\n","uniqueKey":"end_datetime","typeLabel":"string\u003cdate-time>"},"all_datetimes":{"type":"object","description":"Other timestamps related to the gig assignment.","properties":{"request_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig assignment was created.\n","uniqueKey":"all_datetimes.request_at","typeLabel":"string\u003cdate-time>"},"accept_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig assignment was accepted.\n","uniqueKey":"all_datetimes.accept_at","typeLabel":"string\u003cdate-time>"},"pickup_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when \"package\" (rider, food, or similar) was obtained.\n","uniqueKey":"all_datetimes.pickup_at","typeLabel":"string\u003cdate-time>"},"dropoff_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when \"package\" (rider, food, or similar) was delivered.\n","uniqueKey":"all_datetimes.dropoff_at","typeLabel":"string\u003cdate-time>"},"cancel_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the gig assignment was cancelled.\n","uniqueKey":"all_datetimes.cancel_at","typeLabel":"string\u003cdate-time>"},"shift_start":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the work shift started.\n","uniqueKey":"all_datetimes.shift_start","typeLabel":"string\u003cdate-time>"},"shift_end":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the work shift ended.\n","uniqueKey":"all_datetimes.shift_end","typeLabel":"string\u003cdate-time>"},"breaks":{"type":"array","items":{"type":"object","properties":{"break_start":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the break started.\n","uniqueKey":"all_datetimes.breaks.items.[INDEX].break_start","typeLabel":"string\u003cdate-time>"},"break_end":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the break ended.\n","uniqueKey":"all_datetimes.breaks.items.[INDEX].break_end","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"all_datetimes.breaks.items.[INDEX]","typeLabel":"object"},"uniqueKey":"all_datetimes.breaks","typeLabel":"object[]"}},"uniqueKey":"all_datetimes","typeLabel":"object"},"duration":{"type":"integer","description":"Total time of the gig assignment (in seconds).","uniqueKey":"duration","typeLabel":"integer"},"timezone":{"type":"string","description":"Timezone ([IANA](https://www.iana.org/time-zones)) where the gig assignment took place.\n","uniqueKey":"timezone","typeLabel":"string"},"earning_type":{"type":"string","enum":["offer","work","incentive","adjustment","other"],"description":"The earnings category.","uniqueKey":"earning_type","typeLabel":"enum\u003cstring>"},"start_location":{"type":"object","description":"Starting location information for the gig assignment.","properties":{"lat":{"type":"string","description":"Latitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) where the gig assignment started.\nReturned as a decimal string with variable precision. ","format":"degrees","x-argyle-decimal-mode":"variable","uniqueKey":"start_location.lat","typeLabel":"string\u003cdegrees>"},"lng":{"type":"string","description":"Longitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) where the gig assignment started.\nReturned as a decimal string with variable precision. ","format":"degrees","x-argyle-decimal-mode":"variable","uniqueKey":"start_location.lng","typeLabel":"string\u003cdegrees>"},"formatted_address":{"type":"string","description":"Full address of where the gig assignment started.","uniqueKey":"start_location.formatted_address","typeLabel":"string"}},"uniqueKey":"start_location","typeLabel":"object"},"end_location":{"type":"object","description":"Ending location information for the gig assignment.","properties":{"lat":{"type":"string","format":"degrees","description":"Latitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) where the gig assignment ended.\nReturned as a decimal string with variable precision. ","x-argyle-decimal-mode":"variable","uniqueKey":"end_location.lat","typeLabel":"string\u003cdegrees>"},"lng":{"type":"string","format":"degrees","description":"Longitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) where the gig assignment ended.\nReturned as a decimal string with variable precision. ","x-argyle-decimal-mode":"variable","uniqueKey":"end_location.lng","typeLabel":"string\u003cdegrees>"},"formatted_address":{"type":"string","description":"Full address of where the gig assignment ended.","uniqueKey":"end_location.formatted_address","typeLabel":"string"}},"uniqueKey":"end_location","typeLabel":"object"},"task_details":{"type":"object","description":"Task-level details for the gig assignment.","properties":{"events":{"type":"array","description":"Geographical information and timestamps.","items":{"type":"object","properties":{"order_id":{"type":"string","description":"Argyle-added reference ID. Connects `events` to `orders`.\n\n**Note:**\nOnly available if the underlying gig platform provides a clear link between events and their associated orders (monetary charges).\n","uniqueKey":"task_details.events.items.[INDEX].order_id","typeLabel":"string"},"sequence":{"type":"string","description":"Counter starting at 1. The sequential ordering of each event, as represented by the gig platform.\n","uniqueKey":"task_details.events.items.[INDEX].sequence","typeLabel":"string"},"type":{"type":"string","enum":["request","accept","pickup","dropoff","other","cancel"],"description":"The type of event.","uniqueKey":"task_details.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Name associated with the geographical location.\n\n**Note:**\nPrimarily available for delivery platforms, where name is the pickup establishment (i.e. restaurant name).\n","uniqueKey":"task_details.events.items.[INDEX].name","typeLabel":"string"},"formatted_address":{"type":"string","description":"Full address of the geographical location.","uniqueKey":"task_details.events.items.[INDEX].formatted_address","typeLabel":"string"},"lat":{"type":"string","description":"Latitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) of the geographical location.\nReturned as a decimal string with variable precision. ","x-argyle-decimal-mode":"variable","uniqueKey":"task_details.events.items.[INDEX].lat","typeLabel":"string"},"lng":{"type":"string","description":"Longitude ([ISO 6709](https://en.wikipedia.org/wiki/ISO_6709)) of the geographical location.\nReturned as a decimal string with variable precision. ","x-argyle-decimal-mode":"variable","uniqueKey":"task_details.events.items.[INDEX].lng","typeLabel":"string"},"datetime":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the event.\n","uniqueKey":"task_details.events.items.[INDEX].datetime","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"task_details.events.items.[INDEX]","typeLabel":"object"},"uniqueKey":"task_details.events","typeLabel":"object[]"},"orders":{"type":"array","description":"Payment and earnings information.","items":{"type":"object","properties":{"order_id":{"type":"string","description":"Argyle-added reference ID. Connects `orders` to `events`.\n","uniqueKey":"task_details.orders.items.[INDEX].order_id","typeLabel":"string"},"sequence":{"type":"string","description":"Counter starting at 1. The sequential ordering of each order, as represented by the gig platform.\n","uniqueKey":"task_details.orders.items.[INDEX].sequence","typeLabel":"string"},"income":{"type":"object","description":"Payment and earnings information for the order.","properties":{"currency":{"type":"string","description":"Currency code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).\n","uniqueKey":"task_details.orders.items.[INDEX].income.currency","typeLabel":"string"},"total_charge":{"type":"string","description":"Total amount charged to the customer. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.total_charge","typeLabel":"string"},"customer_price":{"type":"string","description":"Amount the customer paid for the order, not including `fees` and `tips`.\nReturned as a decimal string with exactly two decimal places. ","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.customer_price","typeLabel":"string"},"fees":{"type":"string","description":"Fees charged to the gig employee by the gig platform. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.fees","typeLabel":"string"},"total":{"type":"string","description":"Total earnings received by the gig employee ( `pay` + `tips` + `bonus` + `other` ).\nReturned as a decimal string with exactly two decimal places. ","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.total","typeLabel":"string"},"pay":{"type":"string","description":"Earnings related to the assignment received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.pay","typeLabel":"string"},"tips":{"type":"string","description":"Tips received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.tips","typeLabel":"string"},"bonus":{"type":"string","description":"Bonus earnings received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.bonus","typeLabel":"string"},"other":{"type":"string","description":"Other payments made or received by the gig employee.\n\nCommon examples: refunds (tolls), taxes, partial cash payments, reimbursements, or miscellaneous payments categorized as \"other\".\n\nReturned as a decimal string with exactly two decimal places.\n","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"task_details.orders.items.[INDEX].income.other","typeLabel":"string"}},"uniqueKey":"task_details.orders.items.[INDEX].income","typeLabel":"object"}},"uniqueKey":"task_details.orders.items.[INDEX]","typeLabel":"object"},"uniqueKey":"task_details.orders","typeLabel":"object[]"}},"uniqueKey":"task_details","typeLabel":"object"},"distance":{"type":"string","description":"Distance traveled during the gig assignment. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"distance","typeLabel":"string"},"distance_unit":{"type":"string","enum":["miles","km"],"description":"Unit of the distance traveled.","uniqueKey":"distance_unit","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Additional, non-categorized information.\n","uniqueKey":"metadata","typeLabel":"object"},"circumstances":{"type":"object","description":"Metadata specific to the gig platform, such as whether the assignment occurred during peak hours.","uniqueKey":"circumstances","typeLabel":"object"},"income":{"type":"object","description":"Payment and earnings information for the gig assignment.","properties":{"currency":{"type":"string","description":"Currency code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).\n","uniqueKey":"income.currency","typeLabel":"string"},"total_charge":{"type":"string","description":"Total amount charged to the customer. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.total_charge","typeLabel":"string"},"customer_price":{"type":"string","description":"Amount the customer paid for the order, not including `fees` and `tips`.\n\n**Note:**\nOnly available if directly returned by the gig platform.\n\nReturned as a decimal string with exactly two decimal places.\n","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.customer_price","typeLabel":"string"},"fees":{"type":"string","description":"Fees charged to the gig employee by the gig platform. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.fees","typeLabel":"string"},"total":{"type":"string","description":"Total earnings received by the gig employee ( `pay` + `tips` + `bonus` + `other` ).\nReturned as a decimal string with exactly two decimal places. ","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.total","typeLabel":"string"},"pay":{"type":"string","description":"Earnings related to the assignment received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.pay","typeLabel":"string"},"tips":{"type":"string","description":"Tips received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.tips","typeLabel":"string"},"bonus":{"type":"string","description":"Bonus earnings received by the gig employee. Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.bonus","typeLabel":"string"},"other":{"type":"string","description":"Other payments made or received by the gig employee.\n\nCommon examples: refunds (tolls), taxes, partial cash payments, reimbursements, or miscellaneous payments categorized as \"other\".\n\n**Note:**\n Additional details for other income are listed within metadata in the following format:\n\n ```json\n \"metadata\": {\n \"income.other\": {\n \"name\": \"Taxes: Withholding tax\",\n \"value\": \"-15.32\"\n }\n }\n ```\n\nReturned as a decimal string with exactly two decimal places.\n","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income.other","typeLabel":"string"}},"uniqueKey":"income","typeLabel":"object"},"income_rates":{"type":"object","description":"Amount earned by the gig employee per hour or per mile.\n\n**Note:**\nValues are not calculated, and are only returned if directly provided by the gig platform.\n","properties":{"hour":{"type":"string","description":"Earnings per hour. *Not calculated* Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income_rates.hour","typeLabel":"string"},"mile":{"type":"string","description":"Earnings per mile. *Not calculated* Returned as a decimal string with exactly two decimal places.","x-argyle-decimal-places":2,"x-argyle-decimal-mode":"fixed","uniqueKey":"income_rates.mile","typeLabel":"string"}},"uniqueKey":"income_rates","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"originalFileLocation":"openAPI/argyle-all.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Gigs - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-17T23:23:17.205Z","originalFileLocation":"api-reference/gigs.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=\"Retrieve information specific to gig employments.\">\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=\"Gigs - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve information specific to gig employments.\">\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/gigs\">\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=\"Gigs - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve information specific to gig employments.\">\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/gigs\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/gigs.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/gigs#webpage\",\"url\":\"https://docs.argyle.com/api-reference/gigs\",\"name\":\"Gigs\",\"description\":\"Retrieve information specific to gig employments.\",\"dateModified\":\"2026-02-17T23:23:17.205Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/gigs#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/gigs#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payroll Data Sets\",\"item\":\"https://docs.argyle.com/api-reference/identities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Gigs\",\"item\":\"https://docs.argyle.com/api-reference/gigs\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/gigs#apireference\",\"headline\":\"Gigs\",\"name\":\"Gigs\",\"description\":\"Retrieve information specific to gig employments.\",\"url\":\"https://docs.argyle.com/api-reference/gigs\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/gigs#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-02-17T23:23:17.205Z\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"}}]}\u003c/script>","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","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","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","description":"Returns a paginated list of all shift objects.\n","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","description":"Retrieves a gig object.\n","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"}]},{"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":"Gigs - Argyle Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}