{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
People
Create people in batch
Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.
{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
Create up to 100 people in the workspace, each optionally added to one or more groups. Each record takes the same fields as create a person and is created on its own: a record that fails, for instance because it names a company ID that does not exist, does not prevent the others from being created. See batch requests for the 100-record limit and how to read the response.Every record creates a new person, even when two records are identical or match an existing person. A company given by name is linked to the existing company of that name, or created if there is none. Records naming the same new company are all linked to one created company. Names match exactly, so Acme and acme are two companies.Each created person comes back in full, as in the response of create a person.A record that was created but could not be fully set up, for instance because the person could not be added to one of its groups, succeeds with a warnings list explaining what was not applied.
folk automatically checks for duplicates when creating people. If the system
detects a duplicate, the newly created person will be merged in the
background, possibly overwriting some of the provided data.
Authorizations
Authorization
string
header
required
API key for authentication
Headers
Idempotency-Key
string
A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.
Maximum string length: 255
Example:
"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
application/json
records
object[]
required
Maximum array length: 100
Show child attributes
Response
The outcome of each record, with each created person.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Folk Developer Portal","description":"Developer portal and API reference of folk","colors":{"primary":"#000000","light":"#ffffff","dark":"#222222"},"logo":{"light":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8","dark":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=f7a85c0692d36cf4ae95ba0cb3a13827"},"favicon":{"light":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-light.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=f507f5945e391292cf6679ecee54f2a0","dark":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-dark.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=26f07b15afad6f7a4467054d25a0f955"},"api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python","ruby","go","php"]}},"navbar":{"links":[{"href":"intercom://show","label":"Chat with support"},{"href":"https://www.folk.app/contact-sales","label":"Get a demo"}],"primary":{"type":"button","label":"Open app","href":"https://app.folk.app"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/folkhq","x":"https://twitter.com/folkhq","youtube":"https://www.youtube.com/channel/UCs3bswOUZvkouum7Rdx4i5w"}},"integrations":{"intercom":{"appId":"rn8e78eq"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"folk-cf968f5e","hasAudioNarration":false,"actualSubdomain":"folk-cf968f5e","customDomains":["developer.folk.app"],"gitSource":{"type":"github","owner":"folkapp-mintlify-prod","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff363a7fb6886116678472","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":104},{"language":"default","tag":"Available endpoints","count":93},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Campaigns","count":17},{"language":"default","tag":"Introduction","count":11},{"language":"default","tag":"Core concepts","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Companies","count":8},{"language":"default","tag":"Custom objects","count":8},{"language":"default","tag":"People","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGHInHEVA.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGGInHEVA.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGIInE.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--font-family-headings-custom: 'Bricolage Grotesque', sans-serif}h1,h2,h3,h4,h5,h6{font-optical-sizing:auto;font-weight:600;font-style:normal;font-variation-settings:'wdth' 100}.dark{--background-dark: 25 25 25}.dark #topbar-cta-button>a>span,#home-cta-button{border:1px solid rgb(var(--gray-800))}.prose :where(a):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){border-color:rgb(var(--primary-dark))}.dark .prose :where(a):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){border-color:rgb(var(--primary-light))}.nav-tag-pill-text{font-weight:500!important;text-shadow:none;color:#ffffff!important;background-color:#2563eb!important}.dark .nav-tag-pill-text{background-color:#3b82f6!important}"}]}
{"page":{"pagePath":"api-reference/people/create-people-in-batch","slug":"/api-reference/people/create-people-in-batch","pageMetadata":{"openapi":"post /v1/people/batch/create","title":"Create people in batch","description":"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.","href":"/api-reference/people/create-people-in-batch"},"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: \"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Create up to 100 people in the workspace, each optionally added to one or more groups. Each record takes the same fields as `,_jsx(_components.a,{href:`/api-reference/people/create-a-person`,children:`create a person`}),` and is created on its own: a record that fails, for instance because it names a company ID that does not exist, does not prevent the others from being created. See `,_jsx(_components.a,{href:`/api-reference/batch-requests`,children:`batch requests`}),` for the 100-record limit and how to read the response.`]}),`\n`,_jsxs(_components.p,{children:[`Every record creates a new person, even when two records are identical or match an existing person. A company given by `,_jsx(_components.code,{children:`name`}),` is linked to the existing company of that name, or created if there is none. Records naming the same new company are all linked to one created company. Names match exactly, so `,_jsx(_components.code,{children:`Acme`}),` and `,_jsx(_components.code,{children:`acme`}),` are two companies.`]}),`\n`,_jsxs(_components.p,{children:[`Each created person comes back in full, as in the response of `,_jsx(_components.a,{href:`/api-reference/people/create-a-person`,children:`create a person`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`A record that was created but could not be fully set up, for instance because the person could not be added to one of its groups, succeeds with a `,_jsx(_components.code,{children:`warnings`}),` list explaining what was not applied.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`folk automatically checks for duplicates when creating people. If the system\ndetects a duplicate, the newly created person will be merged in the\nbackground, possibly overwriting some of the provided data.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/people/batch/create","title":"Create people in batch","description":"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.","href":"/api-reference/people/create-people-in-batch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/folk-cf968f5e/c239747596c4df94/intercom.js"],"openApiReferenceData":{"operation":{"security":["cc4f305e-7125-48d2-a52c-f1237abaad50"],"operationId":"batchCreatePeople","summary":"Create people in batch","description":"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.","tags":["People"],"parameters":["2f7d768f-8fdb-4037-9e34-9d280dc10a9f"],"requestBody":"e3fa7adf-7f61-46ec-b771-4e82a850998e","responses":{"200":"d0e14212-15b7-4d5a-be8a-205e26c3b5c9","400":"dab08421-8883-48da-8786-e30544a92779","401":"bce4bbd2-729e-4e2a-b300-98f6be4c605e","403":"a280e291-cb59-4ce8-a63a-c3ebfab36ed2","404":"4b074323-5f12-4d64-bbe5-30a0bd3f36a1","409":"928975ef-c8db-4f3e-9a15-d4eacdfc3294","422":"01b4e399-8c08-4652-9ef5-c9c81db7a00f","429":"d14ffb5f-0ced-45ff-aaa4-39cd7528a4bf","500":"4eb2c07d-829b-4afa-87f6-613fcce3b368","503":"f4411e00-30b5-42a7-9499-3ef6b8c75ec7"},"method":"post","type":"path","servers":["1de91bb1-f79d-4a5f-a53d-ad4dd945e0f0"],"path":"/v1/people/batch/create","baseUrlOptions":["https://api.folk.app"],"title":"Create people in batch","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","ruby","go","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2f7d768f-8fdb-4037-9e34-9d280dc10a9f":{"schema":{"type":"string","maxLength":255,"description":"A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.","example":"8e03978e-40d5-43e8-bc93-6894a57f9324","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.","name":"Idempotency-Key","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","maxLength":500,"description":"The first name of the person.","example":"John","uniqueKey":"records.items.[INDEX].firstName","typeLabel":"string"},"lastName":{"type":"string","maxLength":500,"description":"The last name of the person.","example":"Doe","uniqueKey":"records.items.[INDEX].lastName","typeLabel":"string"},"fullName":{"type":"string","maxLength":1000,"description":"The full name of the person.","example":"John Doe","uniqueKey":"records.items.[INDEX].fullName","typeLabel":"string"},"description":{"type":"string","maxLength":5000,"description":"A short description of the person.","example":"A brief description of the person.","uniqueKey":"records.items.[INDEX].description","typeLabel":"string"},"birthday":{"oneOf":[{"type":"string","description":"The birthday of the person, in ISO format. Deleted with null or empty string.","format":"date","maxLength":10,"minLength":10,"example":"1990-01-01","uniqueKey":"records.items.[INDEX].birthday.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"string","description":"The birthday of the person, in ISO format. Deleted with null or empty string.","enum":[""],"example":"1990-01-01","uniqueKey":"records.items.[INDEX].birthday.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The birthday of the person, in ISO format. Deleted with null or empty string.","example":"1990-01-01","uniqueKey":"records.items.[INDEX].birthday.oneOf.2","typeLabel":"null"}],"uniqueKey":"records.items.[INDEX].birthday","typeLabel":"string\u003cdate> | enum\u003cstring> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Unknown","Other",null],"description":"The gender of the person. Authorized values are \"Female\", \"Male\", \"Unknown\", \"Other\" or null to delete it.","example":"Unknown","uniqueKey":"records.items.[INDEX].gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Unknown","Other",null],"description":"The gender of the person. Authorized values are \"Female\", \"Male\", \"Unknown\", \"Other\" or null to delete it.","example":"Unknown","uniqueKey":"records.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"records.items.[INDEX].gender","typeLabel":"enum\u003cstring> | null"},"jobTitle":{"type":"string","maxLength":500,"description":"The job title of the person.","example":"Software Engineer","uniqueKey":"records.items.[INDEX].jobTitle","typeLabel":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].groups.items.[INDEX].id","typeLabel":"string"}},"required":["id"],"additionalProperties":false,"uniqueKey":"records.items.[INDEX].groups.items.[INDEX]","typeLabel":"object"},"maxItems":100,"description":"The groups to add the person to. You must provide group ids.","example":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}],"uniqueKey":"records.items.[INDEX].groups","typeLabel":"object[]"},"companies":{"type":"array","items":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":500,"isRequired":true,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX].oneOf.1.id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"records.items.[INDEX].companies.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"The companies associated with the person. You can either provide a name or an id. If you provide a name, the company will be created if it does not already exist. The first company in the list will be the person's primary company.","example":[{"name":"Tech Corp"},{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c"}],"uniqueKey":"records.items.[INDEX].companies","typeLabel":"object[]"},"addresses":{"type":"array","items":{"type":"string","maxLength":500,"description":"","example":"","uniqueKey":"records.items.[INDEX].addresses.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"A list of addresses associated with the person. The first address in the list will be the person's primary address.","example":["123 Main St, Springfield, USA","456 Main St, Springfield, USA"],"uniqueKey":"records.items.[INDEX].addresses","typeLabel":"string[]"},"emails":{"type":"array","items":{"type":"string","maxLength":254,"description":"","example":"","uniqueKey":"records.items.[INDEX].emails.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"A list of email addresses associated with the person. The first email address in the list will be the person's primary email address.","example":["john@example.com","john@techcorp.com"],"uniqueKey":"records.items.[INDEX].emails","typeLabel":"string[]"},"phones":{"type":"array","items":{"type":"string","maxLength":30,"description":"","example":"","uniqueKey":"records.items.[INDEX].phones.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"A list of phone numbers associated with the person. The first phone number in the list will be the person's primary phone number.","example":["+1234567890","+0987654321"],"uniqueKey":"records.items.[INDEX].phones","typeLabel":"string[]"},"urls":{"type":"array","items":{"type":"string","maxLength":2048,"description":"","example":"","uniqueKey":"records.items.[INDEX].urls.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"A list of URLs associated with the person. The first URL in the list will be the person's primary URL.","example":["https://example.com","https://example.com/about"],"uniqueKey":"records.items.[INDEX].urls","typeLabel":"string[]"},"customFieldValues":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"oneOf":[{"type":"null","uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.0","typeLabel":"null"},{"type":"string","maxLength":5000,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.1","typeLabel":"string"},{"type":"number","maximum":1.7976931348623157e+308,"minimum":-1.7976931348623157e+308,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"array","items":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].oneOf.1.id","typeLabel":"string"}},"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["email"],"properties":{"email":{"type":"string","maxLength":254,"isRequired":true,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].oneOf.2.email","typeLabel":"string"}},"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"string · object · object"},"maxItems":1000,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties.oneOf.3","typeLabel":"string · object · object[]"}],"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.additionalProperties","typeLabel":"null | string | number | string · object · object[]"},"properties":{},"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties","typeLabel":"object"},"properties":{},"description":"The custom field values associated with the person, grouped by group ids. The format is the following:\n```json\n{\n \"\u003cgroupId>\": {\n \"\u003ccustomFieldName>\": \"\u003ccustomFieldValue>\"\n }\n}\n```\n\nThe group ids passed must also be provided in the `groups` field, otherwise a validation error will be thrown.\n\nThe format of the custom field value depends on the type of the custom field:\n\n- `textField`: string, eg: `\"Foo\"`\n- `numericField`: number or numeric string, eg: `42` or `\"42\"`\n- `dateField`: ISO 8601 string (YYYY-MM-DD), eg: `\"2021-01-01\"`\n- `singleSelect`: string (option label), eg: `\"Active\"`. Use the exact option labels of the custom field (case-sensitive): an unknown label creates a new option.\n- `multipleSelect`: array of strings (option labels), eg: `[\"B2B\", \"B2C\"]`. Use the exact option labels of the custom field (case-sensitive): an unknown label creates a new option.\n- `contactField`: array of objects with `id` property, eg: `[{\"id\": \"per_20228901-ce2b-418c-a267-671823107d8c\"}]`\n- `userField`: array of objects with either `id` (workspace user id) or `email` (workspace user email) property, eg: `[{\"id\": \"usr_a23373bb-5296-4c59-b2e8-8f121707d562\"}, {\"email\": \"jane@example.com\"}]`\n- `objectField`: array of objects with `id` property, eg: `[{\"id\": \"obj_2f62707c-52c0-421a-a11f-68e1ce9610f4\"}]`\n\nPassing a `null` value or an empty array will unset the custom field value.\n","example":{"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2":{"Status":"Active","Programming languages":["Javascript","Python"],"Join date":"2021-01-01","Relationships":[{"id":"per_ed110a47-5d09-43bf-b2e2-791d8231eb5f"},{"id":"com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03"}]},"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"Favorite color":"Blue","Favorite number":42,"Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6"},{"email":"jane@example.com"}]}},"uniqueKey":"records.items.[INDEX].customFieldValues","typeLabel":"object"}},"additionalProperties":false,"example":{"fullName":"John Doe","jobTitle":"Software Engineer","emails":["john@example.com"],"companies":[{"name":"Example Inc."}],"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}]},"uniqueKey":"records.items.[INDEX]","typeLabel":"object"},"maxItems":100,"isRequired":true,"uniqueKey":"records","typeLabel":"object[]"}},"required":["records"],"example":{"records":[{"fullName":"John Doe","jobTitle":"Software Engineer","emails":["john@example.com"],"companies":[{"name":"Example Inc."}],"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}]}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"records":[{"fullName":"John Doe","jobTitle":"Software Engineer","emails":["john@example.com"],"companies":[{"name":"Example Inc."}],"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d0e14212-15b7-4d5a-be8a-205e26c3b5c9":{"description":"The outcome of each record, with each created person.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","required":["status","data"],"properties":{"status":{"type":"string","enum":["succeeded"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.id","typeLabel":"string"},"firstName":{"type":"string","description":"The first name of the person.","example":"John","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"The last name of the person.","example":"Doe","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.lastName","typeLabel":"string"},"fullName":{"type":"string","description":"The full name of the person.","example":"John Doe","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.fullName","typeLabel":"string"},"description":{"type":"string","description":"A short description of the person.","example":"A brief description of the person.","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.description","typeLabel":"string"},"birthday":{"oneOf":[{"type":"string","minLength":10,"maxLength":10,"format":"date","description":"The birthday of the person, in ISO format. Deleted with null or empty string.","example":"1990-01-01","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.birthday.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","minLength":10,"maxLength":10,"format":"date","description":"The birthday of the person, in ISO format. Deleted with null or empty string.","example":"1990-01-01","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.birthday.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.birthday","typeLabel":"string\u003cdate> | null"},"gender":{"oneOf":[{"type":"string","enum":["Male","Female","Unknown","Other",null],"description":"The gender of the person. Authorized values are \"Female\", \"Male\", \"Unknown\", \"Other\" or null to delete it.","example":"Unknown","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Male","Female","Unknown","Other",null],"description":"The gender of the person. Authorized values are \"Female\", \"Male\", \"Unknown\", \"Other\" or null to delete it.","example":"Unknown","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.gender.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.gender","typeLabel":"enum\u003cstring> | null"},"jobTitle":{"type":"string","description":"The job title of the person.","example":"Software Engineer","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.jobTitle","typeLabel":"string"},"createdAt":{"oneOf":[{"type":"string","minLength":20,"maxLength":40,"description":"The date and time the person was created, in ISO format.","example":"2021-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt.oneOf.0","typeLabel":"string"},{"type":"null","minLength":20,"maxLength":40,"description":"The date and time the person was created, in ISO format.","example":"2021-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt","typeLabel":"string | null"},"createdBy":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy","typeLabel":"object"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.groups.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.groups.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.groups.items.[INDEX]","typeLabel":"object"},"description":"The groups associated with the person.","example":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","name":"Engineering"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.groups","typeLabel":"object[]"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the company.","example":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the company.","example":"Tech Corp","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX]","typeLabel":"object"},"description":"The companies associated with the person. The first company in the list is the person's primary company.","example":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies","typeLabel":"object[]"},"addresses":{"type":"array","items":{"type":"string","description":"An address associated with the person. The first address in the list is the person's primary address.","example":"123 Main St, Springfield, USA","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.addresses.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.addresses","typeLabel":"string[]"},"emails":{"type":"array","items":{"type":"string","description":"An email address associated with the person. The first email address in the list is the person's primary email address.","example":"john@example.com","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.emails.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.emails","typeLabel":"string[]"},"phones":{"type":"array","items":{"type":"string","description":"A phone number associated with the person. The first phone number in the list is the person's primary phone number.","example":"+1234567890","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.phones.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.phones","typeLabel":"string[]"},"urls":{"type":"array","items":{"type":"string","description":"A URL associated with the person. The first URL in the list is the person's primary URL.","example":"https://example.com","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.urls.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.urls","typeLabel":"string[]"},"customFieldValues":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"oneOf":[{"type":"null","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.0","typeLabel":"null"},{"type":"string","description":"A custom field value as a string.","example":"Value 1","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.1","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"An array of values for the custom field.","example":["Value 1","Value 2"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.2","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX].email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"object"},"description":"An array of users associated with the custom field.","example":[{"id":"usr_44b85098-441b-4d7f-9d72-c079b1caec45","fullName":"Jane Doe","email":"jane@example.com"},{"id":"usr_a95a1b90-8e88-4855-bc29-d47b8e2704e1","fullName":"John Doe","email":"john@example.com"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.3","typeLabel":"object[]"},{"type":"array","items":{"oneOf":[{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["person"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["company"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"object"},"description":"An array of relationships associated with the custom field.","example":[{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","fullName":"John Doe","entityType":"person"},{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","fullName":"Tech Corp","entityType":"company"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties.oneOf.4","typeLabel":"object[]"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.additionalProperties","typeLabel":"null · string · string[] · object[] · object[]"},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues","typeLabel":"object"},"interactionMetadata":{"type":"object","properties":{"user":{"type":"object","properties":{"approximateCount":{"type":"integer","minimum":0,"description":"The approximate number of interactions between the current user and the contact.","example":21,"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.user.approximateCount","typeLabel":"integer"},"lastInteractedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The last interaction date between the current user and the contact.","example":"2025-05-01T00:00:00Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.user.lastInteractedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The last interaction date between the current user and the contact.","example":"2025-05-01T00:00:00Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.user.lastInteractedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.user.lastInteractedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["approximateCount","lastInteractedAt"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.user","typeLabel":"object"},"workspace":{"type":"object","properties":{"approximateCount":{"type":"integer","minimum":0,"description":"The approximate number of interactions of your workspace with the contact.","example":42,"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.approximateCount","typeLabel":"integer"},"lastInteractedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The last interaction date of your workspace with the contact.","example":"2025-05-01T00:00:00Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The last interaction date of your workspace with the contact.","example":"2025-05-01T00:00:00Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedAt","typeLabel":"string\u003cdate-time> | null"},"lastInteractedBy":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedBy.items.[INDEX].id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedBy.items.[INDEX].fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedBy.items.[INDEX].email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedBy.items.[INDEX]","typeLabel":"object"},"description":"List of users in your workspace who last interacted with the contact.","example":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace.lastInteractedBy","typeLabel":"object[]"}},"required":["approximateCount","lastInteractedAt","lastInteractedBy"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata.workspace","typeLabel":"object"}},"required":["user","workspace"],"description":"Metadata about interactions with the user and workspace.","example":{"user":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z"},"workspace":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z","lastInteractedBy":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}]}},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.interactionMetadata","typeLabel":"object"},"strongestConnection":{"type":"object","additionalProperties":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.strongestConnection.additionalProperties.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.strongestConnection.additionalProperties.fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.strongestConnection.additionalProperties.email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.strongestConnection.additionalProperties","typeLabel":"object"},"description":"For each group the person is in, the workspace member with the strongest connection to the person. If the person has no strongest connection, this will be an empty object. Only the groups for which the person has a strongest connection will be included.","example":{"grp_92346499-30bf-4278-ae8e-4aa3ae2ace2c":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.strongestConnection","typeLabel":"object"}},"required":["id","firstName","lastName","fullName","description","birthday","gender","jobTitle","createdAt","createdBy","groups","companies","addresses","emails","phones","urls","customFieldValues","interactionMetadata"],"description":"A person in the workspace.","example":{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","firstName":"John","lastName":"Doe","fullName":"John Doe","description":"John Doe is a software engineer at Tech Corp.","birthday":"1980-06-15","gender":"Female","jobTitle":"Software Engineer","createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","name":"Engineering"}],"companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"addresses":["123 Main St, Springfield, USA","456 Main St, Springfield, USA"],"emails":["john@example.com","john@techcorp.com"],"phones":["+1234567890","+0987654321"],"urls":["https://example.com"],"customFieldValues":{"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2":{"Status":"Active","Programming languages":["Javascript","Python"],"Join date":"2021-01-01","Relationships":[{"id":"per_ed110a47-5d09-43bf-b2e2-791d8231eb5f","fullName":"Bob Smith","entityType":"person"},{"id":"com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03","fullName":"HR services","entityType":"company"}]},"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"Favorite color":"Blue","Favorite number":"42","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}},"interactionMetadata":{"user":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z"},"workspace":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z","lastInteractedBy":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}]}},"strongestConnection":{"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}}},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.results.items.[INDEX].oneOf.0.warnings.items.[INDEX]","typeLabel":"string"},"description":"What could not be applied to this record although it succeeded, such as a group it could not be added to.","uniqueKey":"data.results.items.[INDEX].oneOf.0.warnings","typeLabel":"string[]"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"code":{"type":"string","example":"NOT_FOUND","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","example":"Not found.","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#not-found","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.documentationUrl","typeLabel":"string\u003curi>"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.details","typeLabel":"object"}},"required":["code","message","documentationUrl"],"description":"Why this record did not succeed.","example":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error","typeLabel":"object"}},"uniqueKey":"data.results.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"data.results.items.[INDEX]","typeLabel":"object"},"description":"One result per record, in the order of `records`: the first result is the outcome of the first record.","isRequired":true,"uniqueKey":"data.results","typeLabel":"object[]"}},"required":["results"],"example":{"results":[{"status":"succeeded","data":{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","firstName":"John","lastName":"Doe","fullName":"John Doe","description":"John Doe is a software engineer at Tech Corp.","birthday":"1980-06-15","gender":"Female","jobTitle":"Software Engineer","createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","name":"Engineering"}],"companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"addresses":["123 Main St, Springfield, USA","456 Main St, Springfield, USA"],"emails":["john@example.com","john@techcorp.com"],"phones":["+1234567890","+0987654321"],"urls":["https://example.com"],"customFieldValues":{"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2":{"Status":"Active","Programming languages":["Javascript","Python"],"Join date":"2021-01-01","Relationships":[{"id":"per_ed110a47-5d09-43bf-b2e2-791d8231eb5f","fullName":"Bob Smith","entityType":"person"},{"id":"com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03","fullName":"HR services","entityType":"company"}]},"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"Favorite color":"Blue","Favorite number":"42","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}},"interactionMetadata":{"user":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z"},"workspace":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z","lastInteractedBy":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}]}},"strongestConnection":{"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"deprecations":{"type":"array","items":{"type":"string","uniqueKey":"deprecations.items.[INDEX]","typeLabel":"string"},"example":["This field is deprecated"],"uniqueKey":"deprecations","typeLabel":"string[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"results":[{"status":"succeeded","data":{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","firstName":"John","lastName":"Doe","fullName":"John Doe","description":"John Doe is a software engineer at Tech Corp.","birthday":"1980-06-15","gender":"Female","jobTitle":"Software Engineer","createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","name":"Engineering"}],"companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"addresses":["123 Main St, Springfield, USA","456 Main St, Springfield, USA"],"emails":["john@example.com","john@techcorp.com"],"phones":["+1234567890","+0987654321"],"urls":["https://example.com"],"customFieldValues":{"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2":{"Status":"Active","Programming languages":["Javascript","Python"],"Join date":"2021-01-01","Relationships":[{"id":"per_ed110a47-5d09-43bf-b2e2-791d8231eb5f","fullName":"Bob Smith","entityType":"person"},{"id":"com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03","fullName":"HR services","entityType":"company"}]},"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"Favorite color":"Blue","Favorite number":"42","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}},"interactionMetadata":{"user":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z"},"workspace":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z","lastInteractedBy":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}]}},"strongestConnection":{"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]}},"examples":{"Example":{"title":"Example","value":{"data":{"results":[{"status":"succeeded","data":{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","firstName":"John","lastName":"Doe","fullName":"John Doe","description":"John Doe is a software engineer at Tech Corp.","birthday":"1980-06-15","gender":"Female","jobTitle":"Software Engineer","createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"groups":[{"id":"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","name":"Engineering"}],"companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"addresses":["123 Main St, Springfield, USA","456 Main St, Springfield, USA"],"emails":["john@example.com","john@techcorp.com"],"phones":["+1234567890","+0987654321"],"urls":["https://example.com"],"customFieldValues":{"grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2":{"Status":"Active","Programming languages":["Javascript","Python"],"Join date":"2021-01-01","Relationships":[{"id":"per_ed110a47-5d09-43bf-b2e2-791d8231eb5f","fullName":"Bob Smith","entityType":"person"},{"id":"com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03","fullName":"HR services","entityType":"company"}]},"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"Favorite color":"Blue","Favorite number":"42","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}},"interactionMetadata":{"user":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z"},"workspace":{"approximateCount":21,"lastInteractedAt":"2025-05-01T00:00:00Z","lastInteractedBy":[{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}]}},"strongestConnection":{"grp_acdf2ad9-6a66-4d32-8594-9694913ac717":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"}}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"dab08421-8883-48da-8786-e30544a92779":{"description":"The request was unacceptable, often due to missing an invalid parameter.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bce4bbd2-729e-4e2a-b300-98f6be4c605e":{"description":"No valid API key provided.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a280e291-cb59-4ce8-a63a-c3ebfab36ed2":{"description":"The API key doesn’t have permissions to perform the request.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4b074323-5f12-4d64-bbe5-30a0bd3f36a1":{"description":"The requested resource doesn’t exist.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"928975ef-c8db-4f3e-9a15-d4eacdfc3294":{"description":"A request with the same `Idempotency-Key` is still being processed, or the resource is in a state that does not allow the operation.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":5},"description":"When the conflict resolves on its own, the number of seconds to wait before retrying."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"IDEMPOTENCY_REQUEST_IN_PROGRESS","message":"A request with the same Idempotency-Key is still being processed. Retry once it has completed.","documentationUrl":"https://developer.folk.app/api-reference/idempotency#errors","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"IDEMPOTENCY_REQUEST_IN_PROGRESS","message":"A request with the same Idempotency-Key is still being processed. Retry once it has completed.","documentationUrl":"https://developer.folk.app/api-reference/idempotency#errors","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"01b4e399-8c08-4652-9ef5-c9c81db7a00f":{"description":"The request was unacceptable, often due to missing or invalid parameters.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d14ffb5f-0ced-45ff-aaa4-39cd7528a4bf":{"description":"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.retryAfter","typeLabel":"string\u003cdate-time>"},"policies":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].retryAfter","typeLabel":"string\u003cdate-time>"}},"required":["policy","limit","remaining","windowSeconds","retryAfter"],"uniqueKey":"error.details.policies.items.[INDEX]","typeLabel":"object"},"description":"The status of every rate limit policy applied to the request.","isRequired":true,"uniqueKey":"error.details.policies","typeLabel":"object[]"}},"required":["policy","limit","remaining","windowSeconds","retryAfter","policies"],"description":"The exceeded rate limit policy. When several are exceeded, the one resetting last.","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response returned when a rate limit is exceeded.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"4eb2c07d-829b-4afa-87f6-613fcce3b368":{"description":"Something went wrong on our end.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f4411e00-30b5-42a7-9499-3ef6b8c75ec7":{"description":"The server is overloaded or down for maintenance.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"cc4f305e-7125-48d2-a52c-f1237abaad50":{"bearerApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"}}},"servers":{"1de91bb1-f79d-4a5f-a53d-ad4dd945e0f0":{"url":"https://api.folk.app","description":"Folk's public API production base URL.","x-internal":false}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key for authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKeyAuth","name":"Authorization"}],"title":"bearerApiKeyAuth"}]},"originalFileLocation":"schemas/2025-06-09.json"},"subdomain":"folk-cf968f5e","siteName":"Folk Developer Portal","title":"Create people in batch - Folk Developer Portal","navMaps":{"firstHrefInVersion":{"2025-06-09":{"href":"/api-reference/people/create-people-in-batch","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T17:47:49.332Z","originalFileLocation":"api-reference/people/create-people-in-batch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create people in batch - Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.folk.app/api-reference/people/create-people-in-batch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://folk-cf968f5e.mintlify.site/_mintlify/api/og/v2?division=People\u0026amp;title=Create+people+in+batch\u0026amp;description=Create+up+to+100+new+people+in+the+workspace.+Each+record+is+created+on+its+own%3A+one+that+fails+does+not+prevent+the+others+from+being+created.\u0026amp;theme=6326573fc3714198be6d933f\u0026amp;signature=8e44be623bf2b08de91f93458614878ab6458ab4c7ff5deed9589072da38204e\">\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=\"Create people in batch - Folk Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://folk-cf968f5e.mintlify.site/_mintlify/api/og/v2?division=People\u0026amp;title=Create+people+in+batch\u0026amp;description=Create+up+to+100+new+people+in+the+workspace.+Each+record+is+created+on+its+own%3A+one+that+fails+does+not+prevent+the+others+from+being+created.\u0026amp;theme=6326573fc3714198be6d933f\u0026amp;signature=8e44be623bf2b08de91f93458614878ab6458ab4c7ff5deed9589072da38204e\">\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/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.folk.app/api-reference/people/create-people-in-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/people/create-people-in-batch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.folk.app/#organization\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.folk.app#website\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.folk.app/api-reference/people/create-people-in-batch#webpage\",\"url\":\"https://developer.folk.app/api-reference/people/create-people-in-batch\",\"name\":\"Create people in batch\",\"description\":\"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\",\"dateModified\":\"2026-11-19T17:47:49.332Z\",\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"},\"breadcrumb\":{\"@id\":\"https://developer.folk.app/api-reference/people/create-people-in-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.folk.app/api-reference/people/create-people-in-batch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Available endpoints\",\"item\":\"https://developer.folk.app/api-reference/people/list-people\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"People\",\"item\":\"https://developer.folk.app/api-reference/people/list-people\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create people in batch\",\"item\":\"https://developer.folk.app/api-reference/people/create-people-in-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.folk.app/api-reference/people/create-people-in-batch#apireference\",\"headline\":\"Create people in batch\",\"name\":\"Create people in batch\",\"description\":\"Create up to 100 new people in the workspace. Each record is created on its own: one that fails does not prevent the others from being created.\",\"url\":\"https://developer.folk.app/api-reference/people/create-people-in-batch\",\"mainEntityOfPage\":{\"@id\":\"https://developer.folk.app/api-reference/people/create-people-in-batch#webpage\"},\"dateModified\":\"2026-11-19T17:47:49.332Z\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Folk Developer Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Folk Developer Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/people/create-people-in-batch.md","siteName":"Folk Developer Portal","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/quick-start"}]},{"tab":"API Reference","versions":[{"version":"2025-06-09","default":true,"groups":[{"group":"Introduction","pages":[{"title":null,"href":"/api-reference/overview"},{"title":null,"href":"/api-reference/authentication"},{"title":null,"href":"/api-reference/success-responses"},{"title":null,"href":"/api-reference/errors"},{"title":null,"href":"/api-reference/pagination"},{"title":null,"href":"/api-reference/filtering"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Batch requests","href":"/api-reference/batch-requests"},{"title":null,"href":"/api-reference/rate-limits"},{"title":"Request ID","href":"/api-reference/request-id"},{"title":null,"href":"/api-reference/versioning"}]},{"group":"Available endpoints","pages":[{"group":"People","pages":[{"title":"List people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people","href":"/api-reference/people/list-people"},{"openapi":"post /v1/people","title":"Create a person","href":"/api-reference/people/create-a-person"},{"title":"Get a person","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people/{personId}","href":"/api-reference/people/get-a-person"},{"openapi":"patch /v1/people/{personId}","title":"Update a person","href":"/api-reference/people/update-a-person"},{"openapi":"delete /v1/people/{personId}","title":"Delete a person","description":"Delete an existing person in the workspace.","href":"/api-reference/people/delete-a-person"},{"openapi":"post /v1/people/batch/create","title":"Create people in batch","href":"/api-reference/people/create-people-in-batch"},{"openapi":"post /v1/people/batch/update","title":"Update people in batch","description":"Update up to 100 existing people in the workspace, each with the fields `PATCH /v1/people/{personId}` accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.\n\nFields with a list of values (`groups`, `companies`, `addresses`, `emails`, `phones`, `urls`) will **replace the old values**. This means that you must provide the entire list of values for that field, not just the values you want to add.\n\n**`groups` replaces the groups of the person, and removing a group deletes data.** A group you can access that is missing from `groups` is removed from the person, together with the person's custom field values in that group. This is the opposite of `POST /v1/people/batch/create`, where `groups` only adds: the same payload adds groups when it creates a person and removes groups when it updates one. Leave `groups` out to keep the person's groups unchanged. Each result lists the groups it removed in `removedGroups`.\n\nThe records of one person, by its ID or by the ID of a person merged into it, are merged into one update, in request order: the last value given for a field wins, and `customFieldValues` are merged group by group, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that person fails with that error. Each of those records gets its own result, with the person as finally updated.","href":"/api-reference/people/update-people-in-batch"},{"openapi":"post /v1/people/batch/delete","title":"Delete people in batch","href":"/api-reference/people/delete-people-in-batch"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies","href":"/api-reference/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create a company","href":"/api-reference/companies/create-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies/{companyId}","href":"/api-reference/companies/get-a-company"},{"openapi":"patch /v1/companies/{companyId}","title":"Update a company","href":"/api-reference/companies/update-a-company"},{"openapi":"delete /v1/companies/{companyId}","title":"Delete a company","href":"/api-reference/companies/delete-a-company"},{"openapi":"post /v1/companies/batch/create","title":"Create companies in batch","href":"/api-reference/companies/create-companies-in-batch"},{"openapi":"post /v1/companies/batch/update","title":"Update companies in batch","href":"/api-reference/companies/update-companies-in-batch"},{"openapi":"post /v1/companies/batch/delete","title":"Delete companies in batch","href":"/api-reference/companies/delete-companies-in-batch"}]},{"group":"Credits","pages":[{"title":"Get credits","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/credits","href":"/api-reference/credits/get-credits"}]},{"group":"Group members","pages":[{"title":"List group members","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/members","href":"/api-reference/group-members/list-group-members"},{"title":"Add a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/members","href":"/api-reference/group-members/add-a-group-member"},{"title":"Update a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/update-a-group-member"},{"title":"Remove a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/remove-a-group-member"}]},{"group":"Group custom fields","pages":[{"title":"List group custom fields","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/list-group-custom-fields"},{"title":"Create a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/create-a-group-custom-field"},{"title":"Get a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/get-a-group-custom-field"},{"title":"Update a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/update-a-group-custom-field"}]},{"group":"Custom objects","pages":[{"openapi":"get /v1/groups/{groupId}/{objectType}","title":"List objects","href":"/api-reference/custom-objects/list-objects"},{"openapi":"post /v1/groups/{groupId}/{objectType}","title":"Create an object","href":"/api-reference/custom-objects/create-an-object"},{"openapi":"get /v1/groups/{groupId}/{objectType}/{objectId}","title":"Get an object","href":"/api-reference/custom-objects/get-an-object"},{"openapi":"patch /v1/groups/{groupId}/{objectType}/{objectId}","title":"Update an object","href":"/api-reference/custom-objects/update-an-object"},{"openapi":"delete /v1/groups/{groupId}/{objectType}/{objectId}","title":"Delete an object","href":"/api-reference/custom-objects/delete-an-object"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/create","title":"Create objects in batch","href":"/api-reference/custom-objects/create-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/update","title":"Update objects in batch","href":"/api-reference/custom-objects/update-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/delete","title":"Delete objects in batch","href":"/api-reference/custom-objects/delete-objects-in-batch"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups","href":"/api-reference/groups/create-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}","href":"/api-reference/groups/update-a-group"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/me","href":"/api-reference/users/get-the-current-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/{userId}","href":"/api-reference/users/get-a-user"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"openapi":"post /v1/notes","title":"Create a note","href":"/api-reference/notes/create-a-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes/{noteId}","href":"/api-reference/notes/get-a-note"},{"openapi":"patch /v1/notes/{noteId}","title":"Update a note","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/notes/{noteId}","href":"/api-reference/notes/delete-a-note"}]},{"group":"Reminders","pages":[{"title":"List reminders","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders","href":"/api-reference/reminders/list-reminders"},{"openapi":"post /v1/reminders","deprecated":true,"title":"Create a reminder","href":"/api-reference/reminders/create-a-reminder"},{"title":"Get a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders/{reminderId}","href":"/api-reference/reminders/get-a-reminder"},{"openapi":"patch /v1/reminders/{reminderId}","deprecated":true,"title":"Update a reminder","href":"/api-reference/reminders/update-a-reminder"},{"title":"Delete a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/reminders/{reminderId}","href":"/api-reference/reminders/delete-a-reminder"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks/{taskId}","href":"/api-reference/tasks/get-a-task"},{"openapi":"patch /v1/tasks/{taskId}","title":"Update a task","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/tasks/{taskId}","href":"/api-reference/tasks/delete-a-task"},{"title":"Mark a task as done","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-done","href":"/api-reference/tasks/mark-a-task-as-done"},{"title":"Mark a task as to do","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-todo","href":"/api-reference/tasks/mark-a-task-as-to-do"}]},{"group":"Person enrichments","pages":[{"title":"List enrichments of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments","href":"/api-reference/person-enrichments/list-enrichments-of-people"},{"openapi":"post /v1/person-enrichments","title":"Enrich people","href":"/api-reference/person-enrichments/enrich-people"},{"title":"Get an enrichment of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments/{enrichmentId}","href":"/api-reference/person-enrichments/get-an-enrichment-of-people"}]},{"group":"Interactions","pages":[{"title":"(Beta) List interactions","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions","href":"/api-reference/interactions/list-interactions"},{"title":"Create an interaction","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/interactions","href":"/api-reference/interactions/create-an-interaction"},{"title":"(Beta) List past interactions","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List past interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/past","href":"/api-reference/interactions/list-past-interactions"},{"title":"(Beta) List upcoming interactions","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List upcoming interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/upcoming","href":"/api-reference/interactions/list-upcoming-interactions"},{"title":"(Beta) Get a past or upcoming interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a past or upcoming interaction","openapi":"/schemas/2025-06-09.json get /v1/interactions/{interactionId}","href":"/api-reference/interactions/get-a-past-or-upcoming-interaction"},{"title":"(Beta) Update an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update an interaction","openapi":"/schemas/2025-06-09.json patch /v1/interactions/{interactionId}","href":"/api-reference/interactions/update-an-interaction"},{"title":"(Beta) Delete an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete an interaction","openapi":"/schemas/2025-06-09.json delete /v1/interactions/{interactionId}","href":"/api-reference/interactions/delete-an-interaction"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"post /v1/webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"patch /v1/webhooks/{webhookId}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Campaigns","pages":[{"title":"(Beta) List message senders","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List message senders","openapi":"/schemas/2025-06-09.json get /v1/message-senders","href":"/api-reference/campaigns/list-message-senders"},{"title":"(Beta) List campaigns","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List campaigns","openapi":"/schemas/2025-06-09.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"(Beta) Create a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Create a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"(Beta) Get a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"(Beta) Update a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-a-campaign"},{"title":"(Beta) Delete a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"(Beta) List the variables of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the variables of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/variables","href":"/api-reference/campaigns/list-the-variables-of-a-campaign"},{"title":"(Beta) Review a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Review a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/review","href":"/api-reference/campaigns/review-a-campaign"},{"title":"(Beta) List the messages of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the messages of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages","href":"/api-reference/campaigns/list-the-messages-of-a-campaign"},{"title":"(Beta) Get a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a message of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/get-a-message-of-a-campaign"},{"title":"(Beta) Update a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a message of a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/update-a-message-of-a-campaign"},{"title":"(Beta) Update messages of a campaign in batch","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update messages of a campaign in batch","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/messages/batch/update","href":"/api-reference/campaigns/update-messages-of-a-campaign-in-batch"},{"title":"(Beta) Remove a recipient from a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Remove a recipient from a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}/recipients/{contactId}","href":"/api-reference/campaigns/remove-a-recipient-from-a-campaign"},{"title":"(Beta) Put a campaign back to draft","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Put a campaign back to draft","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/draft","href":"/api-reference/campaigns/put-a-campaign-back-to-draft"},{"title":"(Beta) Launch a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Launch a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/launch","href":"/api-reference/campaigns/launch-a-campaign"},{"title":"(Beta) Cancel the schedule of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Cancel the schedule of a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/cancel-schedule","href":"/api-reference/campaigns/cancel-the-schedule-of-a-campaign"},{"title":"(Beta) Stop a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Stop a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/stop","href":"/api-reference/campaigns/stop-a-campaign"}]},{"group":"Views","pages":[{"title":"List views","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/views","href":"/api-reference/views/list-views"},{"title":"Create a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/views","href":"/api-reference/views/create-a-view"},{"title":"Get a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/views/{viewId}","href":"/api-reference/views/get-a-view"},{"title":"Update a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/views/{viewId}","href":"/api-reference/views/update-a-view"},{"title":"Delete a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/views/{viewId}","href":"/api-reference/views/delete-a-view"}]}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Roadmap","pages":[{"title":"Roadmap","href":"/roadmap"}]}]},"basePath":"","title":"Create people in batch - Folk Developer Portal","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}