{"items":[{"type":"link","label":"Onboarded Public API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Onboarded Public API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Onboarded Public API (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Public API for Customers, Partners, and Integrations"}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Clients","link":"/openapi/clients","routeSlug":"/openapi/clients","items":[{"label":"List all clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clients/clients.list","routeSlug":"/openapi/clients/clients.list","metadata":{"seo":{"title":"List all clients","description":"List all clients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clients.list","name":"List all clients","isWebhook":false,"pointer":"/paths/~1api~1v1~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all clients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"custom_attributes","in":"query","schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","schemaId":"schema_92"},{"name":"updated_at_gte","in":"query","schemaId":"schema_92"}],"pointer":"/paths/~1api~1v1~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/clients","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"custom_attributes","in":"query","required":false,"schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/clients","href":"clients/clients.list","openApiOperationId":"clients.list","summary":"List all clients","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_93"}},"schemaId":"schema_93"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_93","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_93"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/clients.list"}],"panels":[]}]},"httpPath":"/api/v1/clients"},{"label":"Create a new client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clients/clients.create","routeSlug":"/openapi/clients/clients.create","metadata":{"seo":{"title":"Create a new client","description":"Create a new client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clients.create","name":"Create a new client","isWebhook":false,"pointer":"/paths/~1api~1v1~1clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_95"}},"schemaId":"schema_95","pointer":"/paths/~1api~1v1~1clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/clients","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_95"}},"responseCodes":["201","400","401","403"],"pointer":"/api/v1/clients","href":"clients/clients.create","openApiOperationId":"clients.create","summary":"Create a new client","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_95","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_95"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1clients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/clients.create"}],"panels":[]}]},"httpPath":"/api/v1/clients"},{"label":"Get a client by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clients/clients.findbyid","routeSlug":"/openapi/clients/clients.findbyid","metadata":{"seo":{"title":"Get a client by ID","description":"Get a client by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clients.findById","name":"Get a client by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1clients~1{client_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a client by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/clients/{client_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"schemaId":"components/schemas/ClientId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/clients/{client_id}","href":"clients/clients.findbyid","openApiOperationId":"clients.findById","summary":"Get a client by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/clients.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/clients/{client_id}"},{"label":"Update a client","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clients/clients.updatebyid","routeSlug":"/openapi/clients/clients.updatebyid","metadata":{"seo":{"title":"Update a client","description":"Update a client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clients.updateById","name":"Update a client","isWebhook":false,"pointer":"/paths/~1api~1v1~1clients~1{client_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_97"}},"schemaId":"schema_97","pointer":"/paths/~1api~1v1~1clients~1{client_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/clients/{client_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"schemaId":"components/schemas/ClientId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_97"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/clients/{client_id}","href":"clients/clients.updatebyid","openApiOperationId":"clients.updateById","summary":"Update a client","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_97","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_97"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/clients.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/clients/{client_id}"},{"label":"Delete a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/clients/clients.deletebyid","routeSlug":"/openapi/clients/clients.deletebyid","metadata":{"seo":{"title":"Delete a client","description":"Delete a client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clients.deleteById","name":"Delete a client","isWebhook":false,"pointer":"/paths/~1api~1v1~1clients~1{client_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_96","required":true}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/clients/{client_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"schemaId":"components/schemas/ClientId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/clients/{client_id}","href":"clients/clients.deletebyid","openApiOperationId":"clients.deleteById","summary":"Delete a client","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1clients~1{client_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/clients.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/clients/{client_id}"}],"content":{"contentType":"group","meta":{"name":"Clients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clients","showPageActions":true},{"nodeType":"markdoc","content":"API for managing clients"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/clients","summary":"List all clients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/clients.list","deprecated":false},{"title":"/api/v1/clients","summary":"Create a new client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/clients.create","deprecated":false},{"title":"/api/v1/clients/{client_id}","summary":"Get a client by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/clients.findbyid","deprecated":false},{"title":"/api/v1/clients/{client_id}","summary":"Update a client","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/clients/clients.updatebyid","deprecated":false},{"title":"/api/v1/clients/{client_id}","summary":"Delete a client","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clients/clients.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Components","link":"/openapi/components","routeSlug":"/openapi/components","items":[{"label":"Create a component URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/components/components.createurl","routeSlug":"/openapi/components/components.createurl","metadata":{"seo":{"title":"Create a component URL","description":"Create a component URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"components.createUrl","name":"Create a component URL","isWebhook":false,"pointer":"/paths/~1api~1v1~1components~1create_url/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a component URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_98"}},"schemaId":"schema_98","pointer":"/paths/~1api~1v1~1components~1create_url/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/components/create_url","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_98"}},"responseCodes":["200","400","401","403"],"pointer":"/api/v1/components/create_url","href":"components/components.createurl","openApiOperationId":"components.createUrl","summary":"Create a component URL","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_98","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_98"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_99"}},"schemaId":"schema_99"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1components~1create_url/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_99","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_99"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/components/components.createurl"}],"panels":[]}]},"httpPath":"/api/v1/components/create_url"}],"content":{"contentType":"group","meta":{"name":"Components"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Components","showPageActions":true},{"nodeType":"markdoc","content":"API for creating embeddable component URLs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/components/create_url","summary":"Create a component URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/components/components.createurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Connected Organizations","link":"/openapi/connected-organizations","routeSlug":"/openapi/connected-organizations","items":[{"label":"List all connected organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-organizations/connected_organizations.list","routeSlug":"/openapi/connected-organizations/connected_organizations.list","metadata":{"seo":{"title":"List all connected organizations","description":"List all connected organizations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connected_organizations.list","name":"List all connected organizations","isWebhook":false,"pointer":"/paths/~1api~1v1~1connected_organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all connected organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"name","in":"query","schemaId":"schema_91"}],"pointer":"/paths/~1api~1v1~1connected_organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/connected_organizations","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"name","in":"query","required":false,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/connected_organizations","href":"connected-organizations/connected_organizations.list","openApiOperationId":"connected_organizations.list","summary":"List all connected organizations","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1connected_organizations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-organizations/connected_organizations.list"}],"panels":[]}]},"httpPath":"/api/v1/connected_organizations"},{"label":"Create a connected organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-organizations/connected_organizations.create","routeSlug":"/openapi/connected-organizations/connected_organizations.create","metadata":{"seo":{"title":"Create a connected organization","description":"Create a connected organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connected_organizations.create","name":"Create a connected organization","isWebhook":false,"pointer":"/paths/~1api~1v1~1connected_organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a connected organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_101"}},"schemaId":"schema_101","pointer":"/paths/~1api~1v1~1connected_organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/connected_organizations","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_101"}},"responseCodes":["200","400","401","403"],"pointer":"/api/v1/connected_organizations","href":"connected-organizations/connected_organizations.create","openApiOperationId":"connected_organizations.create","summary":"Create a connected organization","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_101"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ConnectedOrganization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}},"schemaId":"components/schemas/ConnectedOrganization"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1connected_organizations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectedOrganization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-organizations/connected_organizations.create"}],"panels":[]}]},"httpPath":"/api/v1/connected_organizations"},{"label":"Get a connected organization by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-organizations/connected_organizations.findbyid","routeSlug":"/openapi/connected-organizations/connected_organizations.findbyid","metadata":{"seo":{"title":"Get a connected organization by ID","description":"Get a connected organization by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connected_organizations.findById","name":"Get a connected organization by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a connected organization by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_102","description":"Connected Organization Identifier","required":true}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/connected_organizations/{uid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_102"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/connected_organizations/{uid}","href":"connected-organizations/connected_organizations.findbyid","openApiOperationId":"connected_organizations.findById","summary":"Get a connected organization by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ConnectedOrganization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}},"schemaId":"components/schemas/ConnectedOrganization"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectedOrganization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-organizations/connected_organizations.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/connected_organizations/{uid}"},{"label":"Update a connected organization","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-organizations/connected_organizations.updatebyid","routeSlug":"/openapi/connected-organizations/connected_organizations.updatebyid","metadata":{"seo":{"title":"Update a connected organization","description":"Update a connected organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connected_organizations.updateById","name":"Update a connected organization","isWebhook":false,"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a connected organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_102","description":"Connected Organization Identifier","required":true}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103","pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/connected_organizations/{uid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_102"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_103"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/connected_organizations/{uid}","href":"connected-organizations/connected_organizations.updatebyid","openApiOperationId":"connected_organizations.updateById","summary":"Update a connected organization","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_103"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ConnectedOrganization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}},"schemaId":"components/schemas/ConnectedOrganization"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectedOrganization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-organizations/connected_organizations.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/connected_organizations/{uid}"},{"label":"Delete a connected organization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/connected-organizations/connected_organizations.deletebyid","routeSlug":"/openapi/connected-organizations/connected_organizations.deletebyid","metadata":{"seo":{"title":"Delete a connected organization","description":"Delete a connected organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"connected_organizations.deleteById","name":"Delete a connected organization","isWebhook":false,"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a connected organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_102","description":"Connected Organization Identifier","required":true}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/connected_organizations/{uid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_102"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/connected_organizations/{uid}","href":"connected-organizations/connected_organizations.deletebyid","openApiOperationId":"connected_organizations.deleteById","summary":"Delete a connected organization","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ConnectedOrganization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}},"schemaId":"components/schemas/ConnectedOrganization"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1connected_organizations~1{uid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectedOrganization","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectedOrganization"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-organizations/connected_organizations.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/connected_organizations/{uid}"}],"content":{"contentType":"group","meta":{"name":"Connected Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connected Organizations","showPageActions":true},{"nodeType":"markdoc","content":"API for managing connected organizations and their configuration"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/connected_organizations","summary":"List all connected organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-organizations/connected_organizations.list","deprecated":false},{"title":"/api/v1/connected_organizations","summary":"Create a connected organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/connected-organizations/connected_organizations.create","deprecated":false},{"title":"/api/v1/connected_organizations/{uid}","summary":"Get a connected organization by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-organizations/connected_organizations.findbyid","deprecated":false},{"title":"/api/v1/connected_organizations/{uid}","summary":"Update a connected organization","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/connected-organizations/connected_organizations.updatebyid","deprecated":false},{"title":"/api/v1/connected_organizations/{uid}","summary":"Delete a connected organization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/connected-organizations/connected_organizations.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Employees","link":"/openapi/employees","routeSlug":"/openapi/employees","items":[{"label":"List all employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.list","routeSlug":"/openapi/employees/employees.list","metadata":{"seo":{"title":"List all employees","description":"List all employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.list","name":"List all employees","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"custom_attributes","in":"query","schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","schemaId":"schema_92"},{"name":"updated_at_gte","in":"query","schemaId":"schema_92"}],"pointer":"/paths/~1api~1v1~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/employees","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"custom_attributes","in":"query","required":false,"schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/employees","href":"employees/employees.list","openApiOperationId":"employees.list","summary":"List all employees","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}},"schemaId":"schema_104"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_104","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.list"}],"panels":[]}]},"httpPath":"/api/v1/employees"},{"label":"Create a new employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.create","routeSlug":"/openapi/employees/employees.create","metadata":{"seo":{"title":"Create a new employee","description":"Create a new employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.create","name":"Create a new employee","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_105"}},"schemaId":"schema_105","pointer":"/paths/~1api~1v1~1employees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/employees","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_105"}},"responseCodes":["201","400","401","403"],"pointer":"/api/v1/employees","href":"employees/employees.create","openApiOperationId":"employees.create","summary":"Create a new employee","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_105","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_105"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.create"}],"panels":[]}]},"httpPath":"/api/v1/employees"},{"label":"Get an employee by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.findbyid","routeSlug":"/openapi/employees/employees.findbyid","metadata":{"seo":{"title":"Get an employee by ID","description":"Get an employee by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.findById","name":"Get an employee by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an employee by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/employees/{employee_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"components/schemas/EmployeeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employees/{employee_id}","href":"employees/employees.findbyid","openApiOperationId":"employees.findById","summary":"Get an employee by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/employees/{employee_id}"},{"label":"Update an employee","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.updatebyid","routeSlug":"/openapi/employees/employees.updatebyid","metadata":{"seo":{"title":"Update an employee","description":"Update an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.updateById","name":"Update an employee","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1api~1v1~1employees~1{employee_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/employees/{employee_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"components/schemas/EmployeeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_107"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employees/{employee_id}","href":"employees/employees.updatebyid","openApiOperationId":"employees.updateById","summary":"Update an employee","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_107","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/employees/{employee_id}"},{"label":"Delete an employee","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.deletebyid","routeSlug":"/openapi/employees/employees.deletebyid","metadata":{"seo":{"title":"Delete an employee","description":"Delete an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.deleteById","name":"Delete an employee","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/employees/{employee_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"components/schemas/EmployeeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employees/{employee_id}","href":"employees/employees.deletebyid","openApiOperationId":"employees.deleteById","summary":"Delete an employee","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/employees/{employee_id}"},{"label":"Get onboarding URL for an employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.getonboardingurl","routeSlug":"/openapi/employees/employees.getonboardingurl","metadata":{"seo":{"title":"Get onboarding URL for an employee","description":"Get onboarding URL for an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.getOnboardingUrl","name":"Get onboarding URL for an employee","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1onboarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get onboarding URL for an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1onboarding/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_type","in":"query","schemaId":"schema_108","description":"Type of assignee for onboarding tasks. Defaults to \"employee\"."},{"name":"placement_id","in":"query","schemaId":"schema_109","description":"Scopes the link to a single placement: the candidate sees only that placement's tasks."},{"name":"task_ids","in":"query","schemaId":"schema_91"},{"name":"auto_sequence","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should only be set to true when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. Tasks will be automatically sorted to satisfy their form stages' sequence."},"children":[]}]}]}]},{"name":"locale","in":"query","schemaId":"schema_111","description":"Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability."},{"name":"redirect_to","in":"query","schemaId":"schema_112","description":"Redirect to URL to send the user after onboarding is complete"},{"name":"active_theme_id","in":"query","schemaId":"schema_113","description":"Custom theme for the onboarding form"},{"name":"otp_required","in":"query","schemaId":"schema_114","description":"Whether OTP verification is required before accessing the onboarding form"},{"name":"otp_methods","in":"query","schemaId":"schema_115","description":"Comma-separated list of allowed OTP delivery methods (sms, email)"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1onboarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/employees/{employee_id}/onboarding","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"components/schemas/EmployeeId"}],"query":[{"name":"assignee_type","in":"query","required":false,"schemaId":"schema_108"},{"name":"placement_id","in":"query","required":false,"schemaId":"schema_109"},{"name":"task_ids","in":"query","required":false,"schemaId":"schema_91"},{"name":"auto_sequence","in":"query","required":false,"schemaId":"schema_110"},{"name":"locale","in":"query","required":false,"schemaId":"schema_111"},{"name":"redirect_to","in":"query","required":false,"schemaId":"schema_112"},{"name":"active_theme_id","in":"query","required":false,"schemaId":"schema_113"},{"name":"otp_required","in":"query","required":false,"schemaId":"schema_114"},{"name":"otp_methods","in":"query","required":false,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employees/{employee_id}/onboarding","href":"employees/employees.getonboardingurl","openApiOperationId":"employees.getOnboardingUrl","summary":"Get onboarding URL for an employee","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1onboarding/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.getonboardingurl"}],"panels":[]}]},"httpPath":"/api/v1/employees/{employee_id}/onboarding"},{"label":"Migrate completed task progress","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employees/employees.migratetaskprogress","routeSlug":"/openapi/employees/employees.migratetaskprogress","metadata":{"seo":{"title":"Migrate completed task progress","description":"Migrate completed task progress"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employees.migrateTaskProgress","name":"Migrate completed task progress","isWebhook":false,"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1migrate_completed_tasks_progress/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate completed task progress","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_106","required":true}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1migrate_completed_tasks_progress/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1migrate_completed_tasks_progress/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/employees/{employee_id}/migrate_completed_tasks_progress","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"components/schemas/EmployeeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_117"}},"responseCodes":["204","400","401","403","404"],"pointer":"/api/v1/employees/{employee_id}/migrate_completed_tasks_progress","href":"employees/employees.migratetaskprogress","openApiOperationId":"employees.migrateTaskProgress","summary":"Migrate completed task progress","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_117","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employees~1{employee_id}~1migrate_completed_tasks_progress/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/employees.migratetaskprogress"}],"panels":[]}]},"httpPath":"/api/v1/employees/{employee_id}/migrate_completed_tasks_progress"}],"content":{"contentType":"group","meta":{"name":"Employees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employees","showPageActions":true},{"nodeType":"markdoc","content":"API for managing employees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/employees","summary":"List all employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/employees.list","deprecated":false},{"title":"/api/v1/employees","summary":"Create a new employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/employees.create","deprecated":false},{"title":"/api/v1/employees/{employee_id}","summary":"Get an employee by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/employees.findbyid","deprecated":false},{"title":"/api/v1/employees/{employee_id}","summary":"Update an employee","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/employees/employees.updatebyid","deprecated":false},{"title":"/api/v1/employees/{employee_id}","summary":"Delete an employee","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employees/employees.deletebyid","deprecated":false},{"title":"/api/v1/employees/{employee_id}/onboarding","summary":"Get onboarding URL for an employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/employees.getonboardingurl","deprecated":false},{"title":"/api/v1/employees/{employee_id}/migrate_completed_tasks_progress","summary":"Migrate completed task progress","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/employees/employees.migratetaskprogress","deprecated":false}]}]}]}]}},{"type":"group","label":"Employers","link":"/openapi/employers","routeSlug":"/openapi/employers","items":[{"label":"List all employers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employers/employers.list","routeSlug":"/openapi/employers/employers.list","metadata":{"seo":{"title":"List all employers","description":"List all employers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employers.list","name":"List all employers","isWebhook":false,"pointer":"/paths/~1api~1v1~1employers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all employers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"custom_attributes","in":"query","schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","schemaId":"schema_92"},{"name":"updated_at_gte","in":"query","schemaId":"schema_92"}],"pointer":"/paths/~1api~1v1~1employers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/employers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"custom_attributes","in":"query","required":false,"schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/employers","href":"employers/employers.list","openApiOperationId":"employers.list","summary":"List all employers","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1employers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_118","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employers.list"}],"panels":[]}]},"httpPath":"/api/v1/employers"},{"label":"Create a new employer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employers/employers.create","routeSlug":"/openapi/employers/employers.create","metadata":{"seo":{"title":"Create a new employer","description":"Create a new employer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employers.create","name":"Create a new employer","isWebhook":false,"pointer":"/paths/~1api~1v1~1employers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1api~1v1~1employers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/employers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119"}},"responseCodes":["201","400","401","403","404"],"pointer":"/api/v1/employers","href":"employers/employers.create","openApiOperationId":"employers.create","summary":"Create a new employer","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employers.create"}],"panels":[]}]},"httpPath":"/api/v1/employers"},{"label":"Get an employer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employers/employers.findbyid","routeSlug":"/openapi/employers/employers.findbyid","metadata":{"seo":{"title":"Get an employer by ID","description":"Get an employer by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employers.findById","name":"Get an employer by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an employer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employer_id","in":"path","schemaId":"schema_120","required":true}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/employers/{employer_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employer_id","in":"path","required":true,"schemaId":"components/schemas/EmployerId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employers/{employer_id}","href":"employers/employers.findbyid","openApiOperationId":"employers.findById","summary":"Get an employer by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employers.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/employers/{employer_id}"},{"label":"Update an employer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employers/employers.updatebyid","routeSlug":"/openapi/employers/employers.updatebyid","metadata":{"seo":{"title":"Update an employer","description":"Update an employer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employers.updateById","name":"Update an employer","isWebhook":false,"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employer_id","in":"path","schemaId":"schema_120","required":true}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_121"}},"schemaId":"schema_121","pointer":"/paths/~1api~1v1~1employers~1{employer_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/employers/{employer_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employer_id","in":"path","required":true,"schemaId":"components/schemas/EmployerId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_121"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employers/{employer_id}","href":"employers/employers.updatebyid","openApiOperationId":"employers.updateById","summary":"Update an employer","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_121","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_121"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employers.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/employers/{employer_id}"},{"label":"Delete an employer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/employers/employers.deletebyid","routeSlug":"/openapi/employers/employers.deletebyid","metadata":{"seo":{"title":"Delete an employer","description":"Delete an employer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"employers.deleteById","name":"Delete an employer","isWebhook":false,"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an employer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employer_id","in":"path","schemaId":"schema_120","required":true}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/employers/{employer_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"employer_id","in":"path","required":true,"schemaId":"components/schemas/EmployerId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/employers/{employer_id}","href":"employers/employers.deletebyid","openApiOperationId":"employers.deleteById","summary":"Delete an employer","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}},"schemaId":"components/schemas/Employer"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1employers~1{employer_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employer"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employers/employers.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/employers/{employer_id}"}],"content":{"contentType":"group","meta":{"name":"Employers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employers","showPageActions":true},{"nodeType":"markdoc","content":"API for managing employers"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/employers","summary":"List all employers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employers/employers.list","deprecated":false},{"title":"/api/v1/employers","summary":"Create a new employer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employers/employers.create","deprecated":false},{"title":"/api/v1/employers/{employer_id}","summary":"Get an employer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employers/employers.findbyid","deprecated":false},{"title":"/api/v1/employers/{employer_id}","summary":"Update an employer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/employers/employers.updatebyid","deprecated":false},{"title":"/api/v1/employers/{employer_id}","summary":"Delete an employer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employers/employers.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/openapi/events","routeSlug":"/openapi/events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/events/events.list","routeSlug":"/openapi/events/events.list","metadata":{"seo":{"title":"List events","description":"List webhook event history in ascending created_at order. To avoid advancing cursors past rows from still-open transactions, events are withheld from this endpoint until they are at least 30 seconds old. Narrow the feed with either type (exact event types) or object (every event for an object family); supplying both returns a 400. Cursors are filter-agnostic, so changing filters mid-pagination yields a different slice of history."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"events.list","name":"List events","isWebhook":false,"pointer":"/paths/~1api~1v1~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List webhook event history in ascending created_at order. To avoid advancing cursors past rows from still-open transactions, events are withheld from this endpoint until they are at least 30 seconds old. Narrow the feed with either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact event types) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (every event for an object family); supplying both returns a 400. Cursors are filter-agnostic, so changing filters mid-pagination yields a different slice of history."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_122"},{"name":"limit","in":"query","schemaId":"schema_123","description":"a number between 1 and 1000"},{"name":"created_at_gt","in":"query","schemaId":"schema_92"},{"name":"created_at_lt","in":"query","schemaId":"schema_92"},{"name":"type","in":"query","schemaId":"schema_124","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of event types to return, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.created,job.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"object","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of object families to return every event for, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"components/schemas/EventCursor"},{"name":"limit","in":"query","required":false,"schemaId":"schema_123"},{"name":"created_at_gt","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"created_at_lt","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"type","in":"query","required":false,"schemaId":"schema_124"},{"name":"object","in":"query","required":false,"schemaId":"schema_125"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/events","href":"events/events.list","openApiOperationId":"events.list","summary":"List events","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"EventsList","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventsList"}},"schemaId":"components/schemas/EventsList"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventsList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventsList"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/events.list"}],"panels":[]}]},"httpPath":"/api/v1/events"},{"label":"Get an event by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/events/events.findbyid","routeSlug":"/openapi/events/events.findbyid","metadata":{"seo":{"title":"Get an event by ID","description":"Get an event by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"events.findById","name":"Get an event by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1events~1{event_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an event by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event_id","in":"path","schemaId":"schema_126","required":true}],"pointer":"/paths/~1api~1v1~1events~1{event_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events/{event_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"event_id","in":"path","required":true,"schemaId":"components/schemas/EventId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/events/{event_id}","href":"events/events.findbyid","openApiOperationId":"events.findById","summary":"Get an event by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Event"}},"schemaId":"components/schemas/Event"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1events~1{event_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Event","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Event"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/events.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/events/{event_id}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"API for reading webhook event history"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/events","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/events.list","deprecated":false},{"title":"/api/v1/events/{event_id}","summary":"Get an event by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/events.findbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/openapi/files","routeSlug":"/openapi/files","items":[{"label":"Get a file by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/files/files.findbyid","routeSlug":"/openapi/files/files.findbyid","metadata":{"seo":{"title":"Get a file by ID","description":"Get a file by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"files.findById","name":"Get a file by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1files~1{file_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a file by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_127","required":true}],"pointer":"/paths/~1api~1v1~1files~1{file_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/files/{file_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"schemaId":"components/schemas/FileId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/files/{file_id}","href":"files/files.findbyid","openApiOperationId":"files.findById","summary":"Get a file by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"FileResponse","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileResponse"}},"schemaId":"components/schemas/FileResponse"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1files~1{file_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileResponse"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/files.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/files/{file_id}"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"API for accessing uploaded files"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/files/{file_id}","summary":"Get a file by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/files.findbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Forms","link":"/openapi/forms","routeSlug":"/openapi/forms","items":[{"label":"List all forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/forms/forms.list","routeSlug":"/openapi/forms/forms.list","metadata":{"seo":{"title":"List all forms","description":"List all forms"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"forms.list","name":"List all forms","isWebhook":false,"pointer":"/paths/~1api~1v1~1forms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"name","in":"query","schemaId":"schema_91"},{"name":"tags","in":"query","schemaId":"schema_91"}],"pointer":"/paths/~1api~1v1~1forms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/forms","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"name","in":"query","required":false,"schemaId":"schema_91"},{"name":"tags","in":"query","required":false,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/forms","href":"forms/forms.list","openApiOperationId":"forms.list","summary":"List all forms","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1forms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms/forms.list"}],"panels":[]}]},"httpPath":"/api/v1/forms"},{"label":"Get a form by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/forms/forms.findbyid","routeSlug":"/openapi/forms/forms.findbyid","metadata":{"seo":{"title":"Get a form by ID","description":"Get a form by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"forms.findById","name":"Get a form by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1forms~1{form_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a form by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"form_id","in":"path","schemaId":"schema_129","required":true}],"pointer":"/paths/~1api~1v1~1forms~1{form_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/forms/{form_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"form_id","in":"path","required":true,"schemaId":"components/schemas/FormId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/forms/{form_id}","href":"forms/forms.findbyid","openApiOperationId":"forms.findById","summary":"Get a form by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Form","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Form"}},"schemaId":"components/schemas/Form"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1forms~1{form_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Form","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Form"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forms/forms.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/forms/{form_id}"}],"content":{"contentType":"group","meta":{"name":"Forms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forms","showPageActions":true},{"nodeType":"markdoc","content":"API for accessing forms"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/forms","summary":"List all forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forms/forms.list","deprecated":false},{"title":"/api/v1/forms/{form_id}","summary":"Get a form by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forms/forms.findbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/openapi/tasks","routeSlug":"/openapi/tasks","items":[{"label":"List all tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.list","routeSlug":"/openapi/tasks/tasks.list","metadata":{"seo":{"title":"List all tasks","description":"List all tasks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.list","name":"List all tasks","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"form_id","in":"query","schemaId":"schema_129"},{"name":"employee_id","in":"query","schemaId":"schema_106"},{"name":"employer_id","in":"query","schemaId":"schema_120"},{"name":"client_id","in":"query","schemaId":"schema_96"},{"name":"job_id","in":"query","schemaId":"schema_130"},{"name":"status","in":"query","schemaId":"schema_131"},{"name":"expired_at_lte","in":"query","schemaId":"schema_92"},{"name":"expired_at_gte","in":"query","schemaId":"schema_92"},{"name":"due_at_lte","in":"query","schemaId":"schema_92"},{"name":"due_at_gte","in":"query","schemaId":"schema_92"},{"name":"completed_at_lte","in":"query","schemaId":"schema_92"},{"name":"completed_at_gte","in":"query","schemaId":"schema_92"},{"name":"created_at_lte","in":"query","schemaId":"schema_92"},{"name":"created_at_gte","in":"query","schemaId":"schema_92"},{"name":"updated_at_lte","in":"query","schemaId":"schema_92"},{"name":"updated_at_gte","in":"query","schemaId":"schema_92"}],"pointer":"/paths/~1api~1v1~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/tasks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"form_id","in":"query","required":false,"schemaId":"components/schemas/FormId"},{"name":"employee_id","in":"query","required":false,"schemaId":"components/schemas/EmployeeId"},{"name":"employer_id","in":"query","required":false,"schemaId":"components/schemas/EmployerId"},{"name":"client_id","in":"query","required":false,"schemaId":"components/schemas/ClientId"},{"name":"job_id","in":"query","required":false,"schemaId":"components/schemas/JobId"},{"name":"status","in":"query","required":false,"schemaId":"schema_131"},{"name":"expired_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"expired_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"due_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"due_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"completed_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"completed_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"created_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"created_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/tasks","href":"tasks/tasks.list","openApiOperationId":"tasks.list","summary":"List all tasks","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.list"}],"panels":[]}]},"httpPath":"/api/v1/tasks"},{"label":"Create a new task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.create","routeSlug":"/openapi/tasks/tasks.create","metadata":{"seo":{"title":"Create a new task","description":"Create a new task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.create","name":"Create a new task","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"allow_duplicate","in":"query","schemaId":"schema_133"}],"pointer":"/paths/~1api~1v1~1tasks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_134"}},"schemaId":"schema_134","pointer":"/paths/~1api~1v1~1tasks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/tasks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"allow_duplicate","in":"query","required":false,"schemaId":"schema_133"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_134"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/api/v1/tasks","href":"tasks/tasks.create","openApiOperationId":"tasks.create","summary":"Create a new task","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_134","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_134"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Task","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}},"schemaId":"components/schemas/Task"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"},{"code":"409","description":"DuplicateTaskError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateTaskError"}},"schemaId":"components/schemas/DuplicateTaskError"}],"pointer":"/paths/~1api~1v1~1tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}},{"code":"409","schemaId":"components/schemas/DuplicateTaskError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DuplicateTaskError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.create"}],"panels":[]}]},"httpPath":"/api/v1/tasks"},{"label":"Get a task by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.findbyid","routeSlug":"/openapi/tasks/tasks.findbyid","metadata":{"seo":{"title":"Get a task by ID","description":"Get a task by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.findById","name":"Get a task by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a task by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/tasks/{task_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}","href":"tasks/tasks.findbyid","openApiOperationId":"tasks.findById","summary":"Get a task by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}},"schemaId":"components/schemas/Task"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}"},{"label":"Update a task","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.updatebyid","routeSlug":"/openapi/tasks/tasks.updatebyid","metadata":{"seo":{"title":"Update a task","description":"Update a task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.updateById","name":"Update a task","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_136"}},"schemaId":"schema_136","pointer":"/paths/~1api~1v1~1tasks~1{task_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/tasks/{task_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_136"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}","href":"tasks/tasks.updatebyid","openApiOperationId":"tasks.updateById","summary":"Update a task","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_136","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_136"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}},"schemaId":"components/schemas/Task"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}"},{"label":"Delete a task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.deletebyid","routeSlug":"/openapi/tasks/tasks.deletebyid","metadata":{"seo":{"title":"Delete a task","description":"Delete a task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.deleteById","name":"Delete a task","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/tasks/{task_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}","href":"tasks/tasks.deletebyid","openApiOperationId":"tasks.deleteById","summary":"Delete a task","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}},"schemaId":"components/schemas/Task"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Task"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}"},{"label":"Get task fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.getfields","routeSlug":"/openapi/tasks/tasks.getfields","metadata":{"seo":{"title":"Get task fields","description":"Get task fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.getFields","name":"Get task fields","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get task fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_sensitive_info","in":"query","schemaId":"schema_133"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/tasks/{task_id}/fields","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[{"name":"include_sensitive_info","in":"query","required":false,"schemaId":"schema_133"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}/fields","href":"tasks/tasks.getfields","openApiOperationId":"tasks.getFields","summary":"Get task fields","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.getfields"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}/fields"},{"label":"Update task fields","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.updatefields","routeSlug":"/openapi/tasks/tasks.updatefields","metadata":{"seo":{"title":"Update task fields","description":"Update task fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.updateFields","name":"Update task fields","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update task fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"schemaId":"schema_139","pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/tasks/{task_id}/fields","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_139"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}/fields","href":"tasks/tasks.updatefields","openApiOperationId":"tasks.updateFields","summary":"Update task fields","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_139","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140"}},"schemaId":"schema_140"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1fields/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_140","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_140"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.updatefields"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}/fields"},{"label":"Download task as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.getpdf","routeSlug":"/openapi/tasks/tasks.getpdf","metadata":{"seo":{"title":"Download task as PDF","description":"Download task as PDF"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.getPdf","name":"Download task as PDF","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download task as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/tasks/{task_id}/pdf","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}/pdf","href":"tasks/tasks.getpdf","openApiOperationId":"tasks.getPdf","summary":"Download task as PDF","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"a string","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_91"}},"schemaId":"schema_91"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_91","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_91"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.getpdf"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}/pdf"},{"label":"Get onboarding URL for a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/tasks.getonboardingurl","routeSlug":"/openapi/tasks/tasks.getonboardingurl","metadata":{"seo":{"title":"Get onboarding URL for a task","description":"Get onboarding URL for a task"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tasks.getOnboardingUrl","name":"Get onboarding URL for a task","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1onboarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get onboarding URL for a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1onboarding/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee_type","in":"query","schemaId":"schema_141","required":true},{"name":"locale","in":"query","schemaId":"schema_91"},{"name":"redirect_to","in":"query","schemaId":"schema_91"},{"name":"otp_required","in":"query","schemaId":"schema_114","description":"Whether OTP verification is required before accessing the onboarding form"},{"name":"otp_methods","in":"query","schemaId":"schema_115","description":"Comma-separated list of allowed OTP delivery methods (sms, email)"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1onboarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/tasks/{task_id}/onboarding","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[{"name":"assignee_type","in":"query","required":true,"schemaId":"schema_141"},{"name":"locale","in":"query","required":false,"schemaId":"schema_91"},{"name":"redirect_to","in":"query","required":false,"schemaId":"schema_91"},{"name":"otp_required","in":"query","required":false,"schemaId":"schema_114"},{"name":"otp_methods","in":"query","required":false,"schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}/onboarding","href":"tasks/tasks.getonboardingurl","openApiOperationId":"tasks.getOnboardingUrl","summary":"Get onboarding URL for a task","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1onboarding/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/tasks.getonboardingurl"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}/onboarding"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"API for managing tasks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/tasks","summary":"List all tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks.list","deprecated":false},{"title":"/api/v1/tasks","summary":"Create a new task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/tasks.create","deprecated":false},{"title":"/api/v1/tasks/{task_id}","summary":"Get a task by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks.findbyid","deprecated":false},{"title":"/api/v1/tasks/{task_id}","summary":"Update a task","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tasks/tasks.updatebyid","deprecated":false},{"title":"/api/v1/tasks/{task_id}","summary":"Delete a task","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tasks/tasks.deletebyid","deprecated":false},{"title":"/api/v1/tasks/{task_id}/fields","summary":"Get task fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks.getfields","deprecated":false},{"title":"/api/v1/tasks/{task_id}/fields","summary":"Update task fields","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tasks/tasks.updatefields","deprecated":false},{"title":"/api/v1/tasks/{task_id}/pdf","summary":"Download task as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks.getpdf","deprecated":false},{"title":"/api/v1/tasks/{task_id}/onboarding","summary":"Get onboarding URL for a task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/tasks.getonboardingurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/openapi/jobs","routeSlug":"/openapi/jobs","items":[{"label":"List all jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/jobs/jobs.list","routeSlug":"/openapi/jobs/jobs.list","metadata":{"seo":{"title":"List all jobs","description":"List all jobs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobs.list","name":"List all jobs","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"custom_attributes","in":"query","schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","schemaId":"schema_92"},{"name":"updated_at_gte","in":"query","schemaId":"schema_92"}],"pointer":"/paths/~1api~1v1~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jobs","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"custom_attributes","in":"query","required":false,"schemaId":"schema_91"},{"name":"updated_at_lte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"},{"name":"updated_at_gte","in":"query","required":false,"schemaId":"components/schemas/DateTimeUtc"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/jobs","href":"jobs/jobs.list","openApiOperationId":"jobs.list","summary":"List all jobs","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}},"schemaId":"schema_142"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_142","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_142"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs.list"}],"panels":[]}]},"httpPath":"/api/v1/jobs"},{"label":"Create a new job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/jobs/jobs.create","routeSlug":"/openapi/jobs/jobs.create","metadata":{"seo":{"title":"Create a new job","description":"Create a new job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobs.create","name":"Create a new job","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_143"}},"schemaId":"schema_143","pointer":"/paths/~1api~1v1~1jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jobs","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_143"}},"responseCodes":["201","400","401","403"],"pointer":"/api/v1/jobs","href":"jobs/jobs.create","openApiOperationId":"jobs.create","summary":"Create a new job","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_143","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_143"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs.create"}],"panels":[]}]},"httpPath":"/api/v1/jobs"},{"label":"Get a job by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/jobs/jobs.findbyid","routeSlug":"/openapi/jobs/jobs.findbyid","metadata":{"seo":{"title":"Get a job by ID","description":"Get a job by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobs.findById","name":"Get a job by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a job by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_130","required":true}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jobs/{job_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/jobs/{job_id}","href":"jobs/jobs.findbyid","openApiOperationId":"jobs.findById","summary":"Get a job by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/jobs/{job_id}"},{"label":"Update a job","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/jobs/jobs.updatebyid","routeSlug":"/openapi/jobs/jobs.updatebyid","metadata":{"seo":{"title":"Update a job","description":"Update a job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobs.updateById","name":"Update a job","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_130","required":true}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_144"}},"schemaId":"schema_144","pointer":"/paths/~1api~1v1~1jobs~1{job_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/jobs/{job_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_144"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/jobs/{job_id}","href":"jobs/jobs.updatebyid","openApiOperationId":"jobs.updateById","summary":"Update a job","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_144","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_144"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/jobs/{job_id}"},{"label":"Delete a job","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/jobs/jobs.deletebyid","routeSlug":"/openapi/jobs/jobs.deletebyid","metadata":{"seo":{"title":"Delete a job","description":"Delete a job"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobs.deleteById","name":"Delete a job","isWebhook":false,"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_130","required":true}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/jobs/{job_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"components/schemas/JobId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/jobs/{job_id}","href":"jobs/jobs.deletebyid","openApiOperationId":"jobs.deleteById","summary":"Delete a job","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1jobs~1{job_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/jobs/{job_id}"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"API for managing jobs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jobs","summary":"List all jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/jobs.list","deprecated":false},{"title":"/api/v1/jobs","summary":"Create a new job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jobs/jobs.create","deprecated":false},{"title":"/api/v1/jobs/{job_id}","summary":"Get a job by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/jobs.findbyid","deprecated":false},{"title":"/api/v1/jobs/{job_id}","summary":"Update a job","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/jobs/jobs.updatebyid","deprecated":false},{"title":"/api/v1/jobs/{job_id}","summary":"Delete a job","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/jobs/jobs.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Placements","link":"/openapi/placements","routeSlug":"/openapi/placements","items":[{"label":"List all placements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.list","routeSlug":"/openapi/placements/placements.list","metadata":{"seo":{"title":"List all placements","description":"List all placements"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.list","name":"List all placements","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all placements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"employee_id","in":"query","schemaId":"schema_106"},{"name":"employer_id","in":"query","schemaId":"schema_120"},{"name":"client_id","in":"query","schemaId":"schema_96"},{"name":"job_id","in":"query","schemaId":"schema_130"}],"pointer":"/paths/~1api~1v1~1placements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/placements","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"employee_id","in":"query","required":false,"schemaId":"components/schemas/EmployeeId"},{"name":"employer_id","in":"query","required":false,"schemaId":"components/schemas/EmployerId"},{"name":"client_id","in":"query","required":false,"schemaId":"components/schemas/ClientId"},{"name":"job_id","in":"query","required":false,"schemaId":"components/schemas/JobId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/placements","href":"placements/placements.list","openApiOperationId":"placements.list","summary":"List all placements","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1placements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_145"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.list"}],"panels":[]}]},"httpPath":"/api/v1/placements"},{"label":"Create a new placement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.create","routeSlug":"/openapi/placements/placements.create","metadata":{"seo":{"title":"Create a new placement","description":"Create a new placement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.create","name":"Create a new placement","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new placement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"schemaId":"schema_146","pointer":"/paths/~1api~1v1~1placements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/placements","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_146"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/api/v1/placements","href":"placements/placements.create","openApiOperationId":"placements.create","summary":"Create a new placement","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_146","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_146"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"},{"code":"409","description":"PlacementConflictError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlacementConflictError"}},"schemaId":"components/schemas/PlacementConflictError"}],"pointer":"/paths/~1api~1v1~1placements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}},{"code":"409","schemaId":"components/schemas/PlacementConflictError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlacementConflictError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.create"}],"panels":[]}]},"httpPath":"/api/v1/placements"},{"label":"Get a placement by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.findbyid","routeSlug":"/openapi/placements/placements.findbyid","metadata":{"seo":{"title":"Get a placement by ID","description":"Get a placement by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.findById","name":"Get a placement by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a placement by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"placement_id","in":"path","schemaId":"schema_147","required":true}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/placements/{placement_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"placement_id","in":"path","required":true,"schemaId":"components/schemas/PlacementId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/placements/{placement_id}","href":"placements/placements.findbyid","openApiOperationId":"placements.findById","summary":"Get a placement by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/placements/{placement_id}"},{"label":"Update a placement","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.updatebyid","routeSlug":"/openapi/placements/placements.updatebyid","metadata":{"seo":{"title":"Update a placement","description":"Update a placement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.updateById","name":"Update a placement","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a placement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"placement_id","in":"path","schemaId":"schema_147","required":true}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148"}},"schemaId":"schema_148","pointer":"/paths/~1api~1v1~1placements~1{placement_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/placements/{placement_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"placement_id","in":"path","required":true,"schemaId":"components/schemas/PlacementId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_148"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/placements/{placement_id}","href":"placements/placements.updatebyid","openApiOperationId":"placements.updateById","summary":"Update a placement","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_148","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_148"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/placements/{placement_id}"},{"label":"Delete a placement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.deletebyid","routeSlug":"/openapi/placements/placements.deletebyid","metadata":{"seo":{"title":"Delete a placement","description":"Delete a placement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.deleteById","name":"Delete a placement","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a placement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"placement_id","in":"path","schemaId":"schema_147","required":true}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/placements/{placement_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"placement_id","in":"path","required":true,"schemaId":"components/schemas/PlacementId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/placements/{placement_id}","href":"placements/placements.deletebyid","openApiOperationId":"placements.deleteById","summary":"Delete a placement","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1placements~1{placement_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/placements/{placement_id}"},{"label":"placements.preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.preview","routeSlug":"/openapi/placements/placements.preview","metadata":{"seo":{"title":"placements.preview","description":"Generate a transient placement to preview form requirements without creating it"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.preview","name":"placements.preview","isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"placements.preview","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a transient placement to preview form requirements without creating it"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_149"}},"schemaId":"schema_149","pointer":"/paths/~1api~1v1~1placements~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/placements/preview","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_149"}},"responseCodes":["200","400","401","403"],"pointer":"/api/v1/placements/preview","href":"placements/placements.preview","openApiOperationId":"placements.preview","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_149"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1placements~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.preview"}],"panels":[]}]},"httpPath":"/api/v1/placements/preview"},{"label":"placements.previewDeprecated","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.previewdeprecated","routeSlug":"/openapi/placements/placements.previewdeprecated","metadata":{"seo":{"title":"placements.previewDeprecated","description":"DEPRECATED: Use POST /placements/preview instead"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.previewDeprecated","name":"placements.previewDeprecated","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1preview/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"placements.previewDeprecated","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"DEPRECATED: Use POST /placements/preview instead"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"employee_id","in":"query","schemaId":"schema_106","required":true},{"name":"employer_id","in":"query","schemaId":"schema_120"},{"name":"client_id","in":"query","schemaId":"schema_96"},{"name":"job_id","in":"query","schemaId":"schema_130"}],"pointer":"/paths/~1api~1v1~1placements~1preview/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/placements/preview","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"employee_id","in":"query","required":true,"schemaId":"components/schemas/EmployeeId"},{"name":"employer_id","in":"query","required":false,"schemaId":"components/schemas/EmployerId"},{"name":"client_id","in":"query","required":false,"schemaId":"components/schemas/ClientId"},{"name":"job_id","in":"query","required":false,"schemaId":"components/schemas/JobId"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/placements/preview","href":"placements/placements.previewdeprecated","openApiOperationId":"placements.previewDeprecated","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}},"schemaId":"components/schemas/Placement"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1placements~1preview/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Placement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Placement"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.previewdeprecated"}],"panels":[]}]},"httpPath":"/api/v1/placements/preview"},{"label":"placements.previewTasks","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/placements/placements.previewtasks","routeSlug":"/openapi/placements/placements.previewtasks","metadata":{"seo":{"title":"placements.previewTasks","description":"DEPRECATED: Use POST /placements/preview instead"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"placements.previewTasks","name":"placements.previewTasks","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1placements~1preview_tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"placements.previewTasks","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"DEPRECATED: Use POST /placements/preview instead"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"schemaId":"schema_150","pointer":"/paths/~1api~1v1~1placements~1preview_tasks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/placements/preview_tasks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_150"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/placements/preview_tasks","href":"placements/placements.previewtasks","openApiOperationId":"placements.previewTasks","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_150","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_150"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}},"schemaId":"schema_151"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1placements~1preview_tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_151","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_151"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/placements/placements.previewtasks"}],"panels":[]}]},"httpPath":"/api/v1/placements/preview_tasks"}],"content":{"contentType":"group","meta":{"name":"Placements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Placements","showPageActions":true},{"nodeType":"markdoc","content":"API for managing placements"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/placements","summary":"List all placements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/placements/placements.list","deprecated":false},{"title":"/api/v1/placements","summary":"Create a new placement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/placements/placements.create","deprecated":false},{"title":"/api/v1/placements/{placement_id}","summary":"Get a placement by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/placements/placements.findbyid","deprecated":false},{"title":"/api/v1/placements/{placement_id}","summary":"Update a placement","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/placements/placements.updatebyid","deprecated":false},{"title":"/api/v1/placements/{placement_id}","summary":"Delete a placement","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/placements/placements.deletebyid","deprecated":false},{"title":"/api/v1/placements/preview","summary":"placements.preview","prefix":{"name":"post","color":"post"},"badges":[],"link":"/placements/placements.preview","deprecated":false},{"title":"/api/v1/placements/preview","summary":"placements.previewDeprecated","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/placements/placements.previewdeprecated","deprecated":true},{"title":"/api/v1/placements/preview_tasks","summary":"placements.previewTasks","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/placements/placements.previewtasks","deprecated":true}]}]}]}]}},{"type":"group","label":"Themes","link":"/openapi/themes","routeSlug":"/openapi/themes","items":[{"label":"List all themes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/themes/themes.list","routeSlug":"/openapi/themes/themes.list","metadata":{"seo":{"title":"List all themes","description":"List all themes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"themes.list","name":"List all themes","isWebhook":false,"pointer":"/paths/~1api~1v1~1themes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all themes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"name","in":"query","schemaId":"schema_91"}],"pointer":"/paths/~1api~1v1~1themes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/themes","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"name","in":"query","required":false,"schemaId":"schema_91"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/themes","href":"themes/themes.list","openApiOperationId":"themes.list","summary":"List all themes","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}},"schemaId":"schema_152"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1themes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_152","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_152"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/themes/themes.list"}],"panels":[]}]},"httpPath":"/api/v1/themes"},{"label":"Create a new theme","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/themes/themes.create","routeSlug":"/openapi/themes/themes.create","metadata":{"seo":{"title":"Create a new theme","description":"Create a new theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"themes.create","name":"Create a new theme","isWebhook":false,"pointer":"/paths/~1api~1v1~1themes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new theme","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153","pointer":"/paths/~1api~1v1~1themes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/themes","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_153"}},"responseCodes":["200","400","401","403"],"pointer":"/api/v1/themes","href":"themes/themes.create","openApiOperationId":"themes.create","summary":"Create a new theme","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_153"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Theme","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}},"schemaId":"components/schemas/Theme"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1themes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Theme","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/themes/themes.create"}],"panels":[]}]},"httpPath":"/api/v1/themes"},{"label":"Get a theme by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/themes/themes.findbyid","routeSlug":"/openapi/themes/themes.findbyid","metadata":{"seo":{"title":"Get a theme by ID","description":"Get a theme by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"themes.findById","name":"Get a theme by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a theme by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"theme_id","in":"path","schemaId":"schema_154","required":true}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/themes/{theme_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"theme_id","in":"path","required":true,"schemaId":"components/schemas/ThemeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/themes/{theme_id}","href":"themes/themes.findbyid","openApiOperationId":"themes.findById","summary":"Get a theme by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Theme","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}},"schemaId":"components/schemas/Theme"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Theme","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/themes/themes.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/themes/{theme_id}"},{"label":"Update a theme","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/themes/themes.updatebyid","routeSlug":"/openapi/themes/themes.updatebyid","metadata":{"seo":{"title":"Update a theme","description":"Update a theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"themes.updateById","name":"Update a theme","isWebhook":false,"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a theme","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"theme_id","in":"path","schemaId":"schema_154","required":true}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155","pointer":"/paths/~1api~1v1~1themes~1{theme_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/themes/{theme_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"theme_id","in":"path","required":true,"schemaId":"components/schemas/ThemeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_155"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/themes/{theme_id}","href":"themes/themes.updatebyid","openApiOperationId":"themes.updateById","summary":"Update a theme","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Theme","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}},"schemaId":"components/schemas/Theme"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Theme","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/themes/themes.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/themes/{theme_id}"},{"label":"Delete a theme","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/themes/themes.deletebyid","routeSlug":"/openapi/themes/themes.deletebyid","metadata":{"seo":{"title":"Delete a theme","description":"Delete a theme"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"themes.deleteById","name":"Delete a theme","isWebhook":false,"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a theme","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"theme_id","in":"path","schemaId":"schema_154","required":true}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/themes/{theme_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"theme_id","in":"path","required":true,"schemaId":"components/schemas/ThemeId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/themes/{theme_id}","href":"themes/themes.deletebyid","openApiOperationId":"themes.deleteById","summary":"Delete a theme","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Theme","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}},"schemaId":"components/schemas/Theme"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1themes~1{theme_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Theme","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Theme"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/themes/themes.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/themes/{theme_id}"}],"content":{"contentType":"group","meta":{"name":"Themes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Themes","showPageActions":true},{"nodeType":"markdoc","content":"API for managing themes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/themes","summary":"List all themes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/themes/themes.list","deprecated":false},{"title":"/api/v1/themes","summary":"Create a new theme","prefix":{"name":"post","color":"post"},"badges":[],"link":"/themes/themes.create","deprecated":false},{"title":"/api/v1/themes/{theme_id}","summary":"Get a theme by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/themes/themes.findbyid","deprecated":false},{"title":"/api/v1/themes/{theme_id}","summary":"Update a theme","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/themes/themes.updatebyid","deprecated":false},{"title":"/api/v1/themes/{theme_id}","summary":"Delete a theme","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/themes/themes.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Properties","link":"/openapi/custom-properties","routeSlug":"/openapi/custom-properties","items":[{"label":"List all custom properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-properties/custom_properties.list","routeSlug":"/openapi/custom-properties/custom_properties.list","metadata":{"seo":{"title":"List all custom properties","description":"List all custom properties"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"custom_properties.list","name":"List all custom properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1custom_properties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all custom properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"name","in":"query","schemaId":"schema_91"},{"name":"entity_type","in":"query","schemaId":"schema_156"},{"name":"path","in":"query","schemaId":"schema_91"},{"name":"status","in":"query","schemaId":"schema_157"}],"pointer":"/paths/~1api~1v1~1custom_properties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/custom_properties","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"name","in":"query","required":false,"schemaId":"schema_91"},{"name":"entity_type","in":"query","required":false,"schemaId":"schema_156"},{"name":"path","in":"query","required":false,"schemaId":"schema_91"},{"name":"status","in":"query","required":false,"schemaId":"schema_157"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/custom_properties","href":"custom-properties/custom_properties.list","openApiOperationId":"custom_properties.list","summary":"List all custom properties","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1custom_properties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-properties/custom_properties.list"}],"panels":[]}]},"httpPath":"/api/v1/custom_properties"},{"label":"Create a custom property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-properties/custom_properties.create","routeSlug":"/openapi/custom-properties/custom_properties.create","metadata":{"seo":{"title":"Create a custom property","description":"Create a custom property"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"custom_properties.create","name":"Create a custom property","isWebhook":false,"pointer":"/paths/~1api~1v1~1custom_properties/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomPropertyCreate"}},"schemaId":"components/schemas/CustomPropertyCreate","pointer":"/paths/~1api~1v1~1custom_properties/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/custom_properties","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomPropertyCreate"}},"responseCodes":["200","400","401","403"],"pointer":"/api/v1/custom_properties","href":"custom-properties/custom_properties.create","openApiOperationId":"custom_properties.create","summary":"Create a custom property","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"components/schemas/CustomPropertyCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomPropertyCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomProperty","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}},"schemaId":"components/schemas/CustomProperty"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1custom_properties/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomProperty","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-properties/custom_properties.create"}],"panels":[]}]},"httpPath":"/api/v1/custom_properties"},{"label":"Get a custom property by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-properties/custom_properties.findbyid","routeSlug":"/openapi/custom-properties/custom_properties.findbyid","metadata":{"seo":{"title":"Get a custom property by ID","description":"Get a custom property by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"custom_properties.findById","name":"Get a custom property by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a custom property by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_property_id","in":"path","schemaId":"schema_159","required":true}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/custom_properties/{custom_property_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"custom_property_id","in":"path","required":true,"schemaId":"components/schemas/CustomPropertyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/custom_properties/{custom_property_id}","href":"custom-properties/custom_properties.findbyid","openApiOperationId":"custom_properties.findById","summary":"Get a custom property by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomProperty","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}},"schemaId":"components/schemas/CustomProperty"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomProperty","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-properties/custom_properties.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/custom_properties/{custom_property_id}"},{"label":"Delete a custom property","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-properties/custom_properties.deletebyid","routeSlug":"/openapi/custom-properties/custom_properties.deletebyid","metadata":{"seo":{"title":"Delete a custom property","description":"Delete a custom property"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"custom_properties.deleteById","name":"Delete a custom property","isWebhook":false,"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_property_id","in":"path","schemaId":"schema_159","required":true}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/custom_properties/{custom_property_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"custom_property_id","in":"path","required":true,"schemaId":"components/schemas/CustomPropertyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/custom_properties/{custom_property_id}","href":"custom-properties/custom_properties.deletebyid","openApiOperationId":"custom_properties.deleteById","summary":"Delete a custom property","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomProperty","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}},"schemaId":"components/schemas/CustomProperty"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomProperty","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-properties/custom_properties.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/custom_properties/{custom_property_id}"},{"label":"Deprecate a custom property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-properties/custom_properties.deprecatebyid","routeSlug":"/openapi/custom-properties/custom_properties.deprecatebyid","metadata":{"seo":{"title":"Deprecate a custom property","description":"Deprecate a custom property"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"custom_properties.deprecateById","name":"Deprecate a custom property","isWebhook":false,"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}~1deprecate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecate a custom property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_property_id","in":"path","schemaId":"schema_159","required":true}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}~1deprecate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/custom_properties/{custom_property_id}/deprecate","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"custom_property_id","in":"path","required":true,"schemaId":"components/schemas/CustomPropertyId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/custom_properties/{custom_property_id}/deprecate","href":"custom-properties/custom_properties.deprecatebyid","openApiOperationId":"custom_properties.deprecateById","summary":"Deprecate a custom property","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CustomProperty","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}},"schemaId":"components/schemas/CustomProperty"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1custom_properties~1{custom_property_id}~1deprecate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomProperty","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomProperty"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-properties/custom_properties.deprecatebyid"}],"panels":[]}]},"httpPath":"/api/v1/custom_properties/{custom_property_id}/deprecate"}],"content":{"contentType":"group","meta":{"name":"Custom Properties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Properties","showPageActions":true},{"nodeType":"markdoc","content":"API for managing custom properties"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/custom_properties","summary":"List all custom properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-properties/custom_properties.list","deprecated":false},{"title":"/api/v1/custom_properties","summary":"Create a custom property","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-properties/custom_properties.create","deprecated":false},{"title":"/api/v1/custom_properties/{custom_property_id}","summary":"Get a custom property by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-properties/custom_properties.findbyid","deprecated":false},{"title":"/api/v1/custom_properties/{custom_property_id}","summary":"Delete a custom property","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-properties/custom_properties.deletebyid","deprecated":false},{"title":"/api/v1/custom_properties/{custom_property_id}/deprecate","summary":"Deprecate a custom property","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-properties/custom_properties.deprecatebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Magic Links","link":"/openapi/magic-links","routeSlug":"/openapi/magic-links","items":[{"label":"Create a magic link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/magic-links/magic_links.create","routeSlug":"/openapi/magic-links/magic_links.create","metadata":{"seo":{"title":"Create a magic link","description":"Create a magic link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"magic_links.create","name":"Create a magic link","isWebhook":false,"pointer":"/paths/~1api~1v1~1magic_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a magic link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160","pointer":"/paths/~1api~1v1~1magic_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/magic_links","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_160"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/magic_links","href":"magic-links/magic_links.create","openApiOperationId":"magic_links.create","summary":"Create a magic link","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_160"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1magic_links/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/magic-links/magic_links.create"}],"panels":[]}]},"httpPath":"/api/v1/magic_links"}],"content":{"contentType":"group","meta":{"name":"Magic Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Magic Links","showPageActions":true},{"nodeType":"markdoc","content":"API for creating magic links for user authentication"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/magic_links","summary":"Create a magic link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/magic-links/magic_links.create","deprecated":false}]}]}]}]}},{"type":"group","label":"Subtasks","link":"/openapi/subtasks","routeSlug":"/openapi/subtasks","items":[{"label":"Upload files to a subtask","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subtasks/subtasks.uploadfiles","routeSlug":"/openapi/subtasks/subtasks.uploadfiles","metadata":{"seo":{"title":"Upload files to a subtask","description":"Upload files to a subtask"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subtasks.uploadFiles","name":"Upload files to a subtask","isWebhook":false,"pointer":"/paths/~1api~1v1~1subtasks~1{subtask_id}~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload files to a subtask","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subtask_id","in":"path","schemaId":"schema_162","required":true}],"pointer":"/paths/~1api~1v1~1subtasks~1{subtask_id}~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_163"}},"schemaId":"schema_163","pointer":"/paths/~1api~1v1~1subtasks~1{subtask_id}~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/subtasks/{subtask_id}/upload","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"subtask_id","in":"path","required":true,"schemaId":"components/schemas/SubtaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_163"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/subtasks/{subtask_id}/upload","href":"subtasks/subtasks.uploadfiles","openApiOperationId":"subtasks.uploadFiles","summary":"Upload files to a subtask","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_163","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_163"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"UploadFilesResponse","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadFilesResponse"}},"schemaId":"components/schemas/UploadFilesResponse"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1subtasks~1{subtask_id}~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadFilesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadFilesResponse"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subtasks/subtasks.uploadfiles"}],"panels":[]}]},"httpPath":"/api/v1/subtasks/{subtask_id}/upload"}],"content":{"contentType":"group","meta":{"name":"Subtasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subtasks","showPageActions":true},{"nodeType":"markdoc","content":"Subtask management and file upload API"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/subtasks/{subtask_id}/upload","summary":"Upload files to a subtask","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subtasks/subtasks.uploadfiles","deprecated":false}]}]}]}]}},{"type":"group","label":"Task Change Requests","link":"/openapi/task-change-requests","routeSlug":"/openapi/task-change-requests","items":[{"label":"Create a task change request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/task-change-requests/task_change_requests.create","routeSlug":"/openapi/task-change-requests/task_change_requests.create","metadata":{"seo":{"title":"Create a task change request","description":"Create a task change request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"task_change_requests.create","name":"Create a task change request","isWebhook":false,"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1task_change_requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a task change request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_135","required":true}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1task_change_requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164"}},"schemaId":"schema_164","pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1task_change_requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/tasks/{task_id}/task_change_requests","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"schemaId":"components/schemas/TaskId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_164"}},"responseCodes":["200","201","400","401","403","404"],"pointer":"/api/v1/tasks/{task_id}/task_change_requests","href":"task-change-requests/task_change_requests.create","openApiOperationId":"task_change_requests.create","summary":"Create a task change request","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_164","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_164"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"TaskChangeRequestSkipped","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskChangeRequestSkipped"}},"schemaId":"components/schemas/TaskChangeRequestSkipped"},{"code":"201","description":"TaskChangeRequestCreated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskChangeRequestCreated"}},"schemaId":"components/schemas/TaskChangeRequestCreated"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1tasks~1{task_id}~1task_change_requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TaskChangeRequestSkipped","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskChangeRequestSkipped"}}},{"code":"201","schemaId":"components/schemas/TaskChangeRequestCreated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TaskChangeRequestCreated"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/task-change-requests/task_change_requests.create"}],"panels":[]}]},"httpPath":"/api/v1/tasks/{task_id}/task_change_requests"}],"content":{"contentType":"group","meta":{"name":"Task Change Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Task Change Requests","showPageActions":true},{"nodeType":"markdoc","content":"API for requesting changes to completed tasks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/tasks/{task_id}/task_change_requests","summary":"Create a task change request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/task-change-requests/task_change_requests.create","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"List all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users.list","routeSlug":"/openapi/users/users.list","metadata":{"seo":{"title":"List all users","description":"List all users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users.list","name":"List all users","isWebhook":false,"pointer":"/paths/~1api~1v1~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_91"},{"name":"external_id","in":"query","schemaId":"schema_91"},{"name":"page","in":"query","schemaId":"schema_165"},{"name":"per_page","in":"query","schemaId":"schema_165"}],"pointer":"/paths/~1api~1v1~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","required":false,"schemaId":"schema_91"},{"name":"external_id","in":"query","required":false,"schemaId":"schema_91"},{"name":"page","in":"query","required":false,"schemaId":"components/schemas/NumberFromString"},{"name":"per_page","in":"query","required":false,"schemaId":"components/schemas/NumberFromString"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/users","href":"users/users.list","openApiOperationId":"users.list","summary":"List all users","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users.list"}],"panels":[]}]},"httpPath":"/api/v1/users"},{"label":"Create a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users.create","routeSlug":"/openapi/users/users.create","metadata":{"seo":{"title":"Create a new user","description":"Create a new user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users.create","name":"Create a new user","isWebhook":false,"pointer":"/paths/~1api~1v1~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167","pointer":"/paths/~1api~1v1~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_167"}},"responseCodes":["201","400","401","403","404"],"pointer":"/api/v1/users","href":"users/users.create","openApiOperationId":"users.create","summary":"Create a new user","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"schema_168","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users.create"}],"panels":[]}]},"httpPath":"/api/v1/users"},{"label":"Get a user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users.findbyid","routeSlug":"/openapi/users/users.findbyid","metadata":{"seo":{"title":"Get a user by ID","description":"Get a user by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users.findById","name":"Get a user by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_169","required":true}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/users/{user_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/users/{user_id}","href":"users/users.findbyid","openApiOperationId":"users.findById","summary":"Get a user by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users.updatebyid","routeSlug":"/openapi/users/users.updatebyid","metadata":{"seo":{"title":"Update a user","description":"Update a user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users.updateById","name":"Update a user","isWebhook":false,"pointer":"/paths/~1api~1v1~1users~1{user_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_169","required":true}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170"}},"schemaId":"schema_170","pointer":"/paths/~1api~1v1~1users~1{user_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/users/{user_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_170"}},"responseCodes":["201","400","401","403","404"],"pointer":"/api/v1/users/{user_id}","href":"users/users.updatebyid","openApiOperationId":"users.updateById","summary":"Update a user","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_170","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/users/{user_id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users.deletebyid","routeSlug":"/openapi/users/users.deletebyid","metadata":{"seo":{"title":"Delete a user","description":"Delete a user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users.deleteById","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1api~1v1~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_169","required":true}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/users/{user_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/users/{user_id}","href":"users/users.deletebyid","openApiOperationId":"users.deleteById","summary":"Delete a user","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1users~1{user_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/users/{user_id}"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"API for managing users"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/users","summary":"List all users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/users.list","deprecated":false},{"title":"/api/v1/users","summary":"Create a new user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/users.create","deprecated":false},{"title":"/api/v1/users/{user_id}","summary":"Get a user by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/users.findbyid","deprecated":false},{"title":"/api/v1/users/{user_id}","summary":"Update a user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/users.updatebyid","deprecated":false},{"title":"/api/v1/users/{user_id}","summary":"Delete a user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/users.deletebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"User Groups","link":"/openapi/user-groups","routeSlug":"/openapi/user-groups","items":[{"label":"List user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user-groups/user_groups.list","routeSlug":"/openapi/user-groups/user_groups.list","metadata":{"seo":{"title":"List user groups","description":"Lists the user groups of the organization behind the API credential, ordered by name. Pass the returned id values in the user_group_ids field of POST /users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"user_groups.list","name":"List user groups","isWebhook":false,"pointer":"/paths/~1api~1v1~1user_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the user groups of the organization behind the API credential, ordered by name. Pass the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_group_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform partners can list a connected organization's groups by sending that organization's account id in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarded-Connected-Account-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User groups belong to an organization rather than to an account, so a test key and a live key for the same organization return the same groups with the same identifiers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"},{"name":"name","in":"query","schemaId":"schema_172","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive substring match on the group name. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1user_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/user_groups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"},{"name":"name","in":"query","required":false,"schemaId":"schema_172"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/user_groups","href":"user-groups/user_groups.list","openApiOperationId":"user_groups.list","summary":"List user groups","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}},"schemaId":"schema_173"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1user_groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_173","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-groups/user_groups.list"}],"panels":[]}]},"httpPath":"/api/v1/user_groups"}],"content":{"contentType":"group","meta":{"name":"User Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Groups","showPageActions":true},{"nodeType":"markdoc","content":"API for reading user groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/user_groups","summary":"List user groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-groups/user_groups.list","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/openapi/webhooks","routeSlug":"/openapi/webhooks","items":[{"label":"List all webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/webhooks.list","routeSlug":"/openapi/webhooks/webhooks.list","metadata":{"seo":{"title":"List all webhooks","description":"List all webhooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooks.list","name":"List all webhooks","isWebhook":false,"pointer":"/paths/~1api~1v1~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_89","description":"1-based page number. There is no upper bound; values below 1 are clamped to 1."},{"name":"per_page","in":"query","schemaId":"schema_90","description":"a number between 1 and 100"}],"pointer":"/paths/~1api~1v1~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/webhooks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_89"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/api/v1/webhooks","href":"webhooks/webhooks.list","openApiOperationId":"webhooks.list","summary":"List all webhooks","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174"}},"schemaId":"schema_174"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_174","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_174"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhooks.list"}],"panels":[]}]},"httpPath":"/api/v1/webhooks"},{"label":"Create a new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/webhooks.create","routeSlug":"/openapi/webhooks/webhooks.create","metadata":{"seo":{"title":"Create a new webhook","description":"Create a new webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooks.create","name":"Create a new webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175","pointer":"/paths/~1api~1v1~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/webhooks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_175"}},"responseCodes":["201","400","401","403"],"pointer":"/api/v1/webhooks","href":"webhooks/webhooks.create","openApiOperationId":"webhooks.create","summary":"Create a new webhook","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"}],"pointer":"/paths/~1api~1v1~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"400","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhooks.create"}],"panels":[]}]},"httpPath":"/api/v1/webhooks"},{"label":"Get a webhook by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/webhooks.findbyid","routeSlug":"/openapi/webhooks/webhooks.findbyid","metadata":{"seo":{"title":"Get a webhook by ID","description":"Get a webhook by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooks.findById","name":"Get a webhook by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a webhook by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_176","required":true}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/webhooks/{webhook_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/WebhookId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/webhooks/{webhook_id}","href":"webhooks/webhooks.findbyid","openApiOperationId":"webhooks.findById","summary":"Get a webhook by ID","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhooks.findbyid"}],"panels":[]}]},"httpPath":"/api/v1/webhooks/{webhook_id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/webhooks.updatebyid","routeSlug":"/openapi/webhooks/webhooks.updatebyid","metadata":{"seo":{"title":"Update a webhook","description":"Update a webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooks.updateById","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_176","required":true}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177","pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/webhooks/{webhook_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/WebhookId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_177"}},"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/webhooks/{webhook_id}","href":"webhooks/webhooks.updatebyid","openApiOperationId":"webhooks.updateById","summary":"Update a webhook","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhooks.updatebyid"}],"panels":[]}]},"httpPath":"/api/v1/webhooks/{webhook_id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/webhooks.deletebyid","routeSlug":"/openapi/webhooks/webhooks.deletebyid","metadata":{"seo":{"title":"Delete a webhook","description":"Delete a webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhooks.deleteById","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"form_session","scopes":[],"type":"http","scheme":"bearer"}]},{"schemes":[{"name":"user_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__session"}]},{"schemes":[{"name":"component_session","scopes":[],"type":"apiKey","in":"cookie","paramName":"__component"}]},{"schemes":[{"name":"component_token","scopes":[],"type":"apiKey","in":"header","paramName":"x-component-auth-token"}]},{"schemes":[{"name":"api_token","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_176","required":true}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/webhooks/{webhook_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"schemaId":"components/schemas/WebhookId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"form_session","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"user_session","type":"apiKey","name":"__session","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_session","type":"apiKey","name":"__component","in":"cookie"}],"scopes":[]},{"schemes":[{"id":"component_token","type":"apiKey","name":"x-component-auth-token","in":"header"}],"scopes":[]},{"schemes":[{"id":"api_token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/webhooks/{webhook_id}","href":"webhooks/webhooks.deletebyid","openApiOperationId":"webhooks.deleteById","summary":"Delete a webhook","securityGroups":[{"form_session":[]},{"user_session":[]},{"component_session":[]},{"component_token":[]},{"api_token":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}},"schemaId":"components/schemas/Webhook"},{"code":"400","description":"The request did not match the expected schema","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}},"schemaId":"components/schemas/HttpApiDecodeError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}},"schemaId":"components/schemas/Forbidden"},{"code":"404","description":"ResourceNotFoundError","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}},"schemaId":"components/schemas/ResourceNotFoundError"}],"pointer":"/paths/~1api~1v1~1webhooks~1{webhook_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Webhook"}}},{"code":"400","schemaId":"components/schemas/HttpApiDecodeError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HttpApiDecodeError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forbidden"}}},{"code":"404","schemaId":"components/schemas/ResourceNotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceNotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhooks.deletebyid"}],"panels":[]}]},"httpPath":"/api/v1/webhooks/{webhook_id}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"API for managing webhooks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/webhooks","summary":"List all webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/webhooks.list","deprecated":false},{"title":"/api/v1/webhooks","summary":"Create a new webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhooks.create","deprecated":false},{"title":"/api/v1/webhooks/{webhook_id}","summary":"Get a webhook by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/webhooks.findbyid","deprecated":false},{"title":"/api/v1/webhooks/{webhook_id}","summary":"Update a webhook","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/webhooks.updatebyid","deprecated":false},{"title":"/api/v1/webhooks/{webhook_id}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/webhooks.deletebyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/NumberFromString":{"id":"components/schemas/NumberFromString","kind":"json-schema","title":"NumberFromString","data":{"type":"string","description":"a string to be decoded into a number"}},"components/schemas/DateTimeUtc":{"id":"components/schemas/DateTimeUtc","kind":"json-schema","title":"DateTimeUtc","data":{"type":"string","description":"a string to be decoded into a DateTime.Utc"}},"components/schemas/Client":{"id":"components/schemas/Client","kind":"json-schema","title":"Client","data":{"type":"object","required":["id","name","custom_attributes","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/ClientId"},"name":{"type":"string"},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"A client with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base client schema.","title":"Client"}},"components/schemas/ScalarValueUnknown":{"id":"components/schemas/ScalarValueUnknown","kind":"json-schema","title":"ScalarValueUnknown","data":{"$id":"/schemas/unknown","description":"Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.","title":"ScalarValueUnknown"}},"components/schemas/ClientId":{"id":"components/schemas/ClientId","kind":"json-schema","title":"ClientId","data":{"type":"string","description":"Client Identifier","title":"ClientId","examples":["cl_abc123def456"],"pattern":"^cl_"}},"components/schemas/CustomAttributes":{"id":"components/schemas/CustomAttributes","kind":"json-schema","title":"CustomAttributes","data":{"type":"object","required":[],"properties":{},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"Record of custom attribute values keyed by string path.","title":"CustomAttributes"}},"components/schemas/HttpApiDecodeError":{"id":"components/schemas/HttpApiDecodeError","kind":"json-schema","title":"HttpApiDecodeError","data":{"type":"object","required":["issues","message","_tag"],"properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/Issue"}},"message":{"type":"string"},"_tag":{"type":"string","enum":["HttpApiDecodeError"]}},"additionalProperties":false,"description":"The request did not match the expected schema"}},"components/schemas/Issue":{"id":"components/schemas/Issue","kind":"json-schema","title":"Issue","data":{"type":"object","required":["_tag","path","message"],"properties":{"_tag":{"type":"string","enum":["Pointer","Unexpected","Missing","Composite","Refinement","Transformation","Type","Forbidden"],"description":"The tag identifying the type of parse issue"},"path":{"type":"array","items":{"$ref":"#/components/schemas/PropertyKey"},"description":"The path to the property where the issue occurred"},"message":{"type":"string","description":"A descriptive message explaining the issue"}},"additionalProperties":false,"description":"Represents an error encountered while parsing a value to match the schema"}},"components/schemas/PropertyKey":{"id":"components/schemas/PropertyKey","kind":"json-schema","title":"PropertyKey","data":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","required":["_tag","key"],"properties":{"_tag":{"type":"string","enum":["symbol"]},"key":{"type":"string"}},"additionalProperties":false,"description":"an object to be decoded into a globally shared symbol"}]}},"components/schemas/BadRequestError":{"id":"components/schemas/BadRequestError","kind":"json-schema","title":"BadRequestError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["BadRequestError"]}},"additionalProperties":false}},"components/schemas/Unauthorized":{"id":"components/schemas/Unauthorized","kind":"json-schema","title":"Unauthorized","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["Unauthorized"]}},"additionalProperties":false}},"components/schemas/Forbidden":{"id":"components/schemas/Forbidden","kind":"json-schema","title":"Forbidden","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["Forbidden"]}},"additionalProperties":false}},"components/schemas/ResourceNotFoundError":{"id":"components/schemas/ResourceNotFoundError","kind":"json-schema","title":"ResourceNotFoundError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["ResourceNotFoundError"]}},"additionalProperties":false}},"components/schemas/EmployeeId":{"id":"components/schemas/EmployeeId","kind":"json-schema","title":"EmployeeId","data":{"type":"string","description":"Employee Identifier","title":"EmployeeId","examples":["ee_abc123def456"],"pattern":"^ee_"}},"components/schemas/ConnectedOrganization":{"id":"components/schemas/ConnectedOrganization","kind":"json-schema","title":"ConnectedOrganization","data":{"type":"object","required":["id","name","dba_name","ein","business_email","candidate_support_email","phone","live_account_id","test_account_id","default_language","supported_languages","address","created_at","updated_at"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"candidate_support_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"live_account_id":{"type":"string"},"test_account_id":{"type":"string"},"default_language":{"anyOf":[{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]},{"type":"null"}]},"supported_languages":{"anyOf":[{"type":"array","items":{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]}},{"type":"null"}]},"address":{"anyOf":[{"type":"object","required":["street","secondary","city","state","zip","country","full_address"],"properties":{"street":{"type":"string"},"secondary":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"type":"string","enum":["AND","ARE","ATG","AIA","ALB","ARM","AGO","ATA","ARG","ASM","AUT","AUS","ABW","ALA","AZE","BIH","BRB","BGD","BEL","BFA","BGR","BHR","BDI","BEN","BLM","BMU","BRN","BOL","BES","BRA","BHS","BTN","BVT","BWA","BLR","BLZ","CAN","CCK","COD","CAF","COG","CHE","CIV","COK","CHL","CHN","CMR","COL","CRI","CPV","CUW","CXR","CYP","CZE","DEU","DJI","DNK","DMA","DOM","DZA","ECU","EST","EGY","ESH","ERI","ESP","ETH","FIN","FJI","FLK","FSM","FRO","FRA","GAB","GBR","GRD","GEO","GUF","GGY","GHA","GIB","GRL","GMB","GIN","GLP","GNQ","GRC","SGS","GTM","GUM","GNB","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IRL","ISR","IMN","IND","IOT","IRQ","ISL","ITA","JEY","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA","KOR","KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU","LUX","LVA","LBY","MAR","MCO","MDA","MNE","MAF","MDG","MHL","MKD","MLI","MMR","MNG","MAC","MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM","NCL","NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NIU","NZL","OMN","PAN","PER","PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT","PLW","PRY","QAT","REU","ROU","SRB","RUS","RWA","SAU","SLB","SYC","SWE","SGP","SHN","SVN","SJM","SVK","SLE","SMR","SEN","SOM","SUR","SSD","STP","SLV","SXM","SWZ","TCA","TCD","ATF","TGO","THA","TJK","TKL","TLS","TKM","TUN","TON","TUR","TTO","TUV","TWN","TZA","UKR","UGA","UMI","USA","URY","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","MYT","ZAF","ZMB","ZWE"]},"full_address":{"type":"string"}},"additionalProperties":false},{"type":"null"}]},"trial_end_at":{"$ref":"#/components/schemas/DateTimeUtc"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":false,"title":"ConnectedOrganization"}},"components/schemas/Employee":{"id":"components/schemas/Employee","kind":"json-schema","title":"Employee","data":{"type":"object","required":["id","first_name","last_name","email","phone","date_of_birth","social_security_number","has_middle_name","address","custom_attributes","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/EmployeeId"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}]},"social_security_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_middle_name":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.","title":"Employee"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["street","city","state","country"],"properties":{"street":{"type":"string","examples":["123 Main St"]},"secondary":{"anyOf":[{"type":"string","examples":["Suite 100"]},{"type":"null"}]},"city":{"type":"string","examples":["San Francisco"]},"state":{"type":"string","examples":["CA"]},"zip":{"anyOf":[{"type":"string","examples":["94102"]},{"type":"null"}]},"country":{"type":"string","examples":["US"]},"full_address":{"anyOf":[{"type":"string","examples":["123 Main St, San Francisco, CA 94102"]},{"type":"null"}]}},"additionalProperties":false,"description":"An address resource"}},"components/schemas/Employer":{"id":"components/schemas/Employer","kind":"json-schema","title":"Employer","data":{"type":"object","required":["id","name","dba_name","custom_attributes","active_theme_id","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/EmployerId"},"name":{"type":"string"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"employee_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity_structure":{"anyOf":[{"type":"string","enum":["sole_proprietorship","partnership","llc","corporation","nonprofit","cooperative","professional_corporation"],"description":"Legal entity structure of the employer","title":"EntityStructure"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"active_theme_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"An employer with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employer schema.","title":"Employer"}},"components/schemas/EmployerId":{"id":"components/schemas/EmployerId","kind":"json-schema","title":"EmployerId","data":{"type":"string","description":"Employer Identifier","title":"EmployerId","examples":["er_abc123def456"],"pattern":"^er_"}},"components/schemas/EventCursor":{"id":"components/schemas/EventCursor","kind":"json-schema","title":"EventCursor","data":{"type":"string","description":"Opaque pagination cursor returned by the events list endpoint.","title":"EventCursor","examples":["eyJjcmVhdGVkX2F0IjoiMjAyNi0wNi0yNVQyMDoxMjozNC41NjdaIiwiaWQiOjEyMzQ1fQ"]}},"components/schemas/EventsList":{"id":"components/schemas/EventsList","kind":"json-schema","title":"EventsList","data":{"type":"object","required":["data","next_cursor","has_more"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"next_cursor":{"anyOf":[{"$ref":"#/components/schemas/EventCursor"},{"type":"null"}]},"has_more":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"type":"object","required":["id","type","created_at","account_id","data"],"properties":{"id":{"$ref":"#/components/schemas/EventId"},"type":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"account_id":{"type":"string"},"data":{"$id":"/schemas/unknown","title":"unknown"}},"additionalProperties":false}},"components/schemas/EventId":{"id":"components/schemas/EventId","kind":"json-schema","title":"EventId","data":{"type":"string","description":"Event Identifier","title":"EventId","examples":["event_abc123def456"],"pattern":"^event_"}},"components/schemas/FileId":{"id":"components/schemas/FileId","kind":"json-schema","title":"FileId","data":{"type":"string","description":"File Identifier","examples":["file_abc123def456"]}},"components/schemas/FileResponse":{"id":"components/schemas/FileResponse","kind":"json-schema","title":"FileResponse","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Signed URL to the file, expires in 5 minutes"}},"additionalProperties":false}},"components/schemas/Form":{"id":"components/schemas/Form","kind":"json-schema","title":"Form","data":{"type":"object","required":["id","name","task_reuse_criteria","custom_attributes","tags","form_pages"],"properties":{"id":{"$ref":"#/components/schemas/FormId"},"name":{"type":"string","description":"The name of the form"},"task_reuse_criteria":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria that determine when a new task is created vs reusing an existing one. Values include \"employer\", \"client\", \"job\", or a placement custom attribute path (e.g. \"placement.custom_attributes.location\")."},"children":[]}]}]}],"examples":[["employer","client"]]},"custom_attributes":{"type":"object","required":[],"properties":{},"additionalProperties":{"$id":"/schemas/any","title":"any"}},"tags":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}},"form_pages":{"type":"array","items":{"type":"object","required":["id","description","assignee_type","form_section","form_fields"],"properties":{"id":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"assignee_type":{"type":"string","enum":["employee","employer","system"]},"form_section":{"anyOf":[{"type":"object","required":["id","position","assignee_type"],"properties":{"id":{"type":"string"},"position":{"type":"number"},"assignee_type":{"type":"string","enum":["employee","employer","system"]}},"additionalProperties":false},{"type":"null"}]},"form_fields":{"type":"array","items":{"type":"object","required":["id","type","path","rule","required"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"path":{"type":"string"},"rule":{"$id":"/schemas/unknown","title":"unknown"},"required":{"type":"boolean"},"translations":{"type":"object","required":[],"properties":{},"additionalProperties":{"type":"object","required":[],"properties":{},"additionalProperties":{"type":"string"}}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false}},"components/schemas/FormId":{"id":"components/schemas/FormId","kind":"json-schema","title":"FormId","data":{"type":"string","description":"Form Identifier (lineage uid)","examples":["tlin_abc123def456"]}},"components/schemas/JobId":{"id":"components/schemas/JobId","kind":"json-schema","title":"JobId","data":{"type":"string","description":"Job Identifier","title":"JobId","examples":["job_abc123def456"],"pattern":"^job_"}},"components/schemas/Task":{"id":"components/schemas/Task","kind":"json-schema","title":"Task","data":{"type":"object","required":["id","form_id","form_custom_attributes","name","employee_id","employer_id","client_id","job_id","status","pdf","next_action","expired_at","deletion_scheduled_at","deletion_allowed_at","due_at","completed_at","progress","subtasks","tags","created_at","updated_at","_tag"],"properties":{"id":{"$ref":"#/components/schemas/TaskId"},"form_id":{"$ref":"#/components/schemas/FormId"},"form_custom_attributes":{"type":"object","required":[],"properties":{},"additionalProperties":{"$id":"/schemas/any","title":"any"}},"name":{"type":"string","description":"The name of the form"},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},"client_id":{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},"job_id":{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},"status":{"type":"string","enum":["requires_action","completed","expired"]},"pdf":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["available","generating","pending_completion","not_applicable"],"description":"The availability state of the task PDF. When available, the task PDF download endpoint should return the PDF."}},"additionalProperties":false},"next_action":{"type":"object","required":["type"],"properties":{"type":{"anyOf":[{"type":"string","enum":["employer_action","employee_action","system_action"]},{"type":"null"}]}},"additionalProperties":false},"expired_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_scheduled_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_allowed_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"due_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"completed_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}],"description":"This field is set when the task status changes to completed."},"progress":{"type":"object","required":["percent","numerator","denominator"],"properties":{"percent":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"}},"additionalProperties":false},"subtasks":{"type":"array","items":{"type":"object","required":["id","form_page_id","assignee_type","form_section","progress"],"properties":{"id":{"type":"string"},"form_page_id":{"type":"string"},"assignee_type":{"type":"string","enum":["employee","employer"]},"form_section":{"anyOf":[{"type":"object","required":["id","position","assignee_type"],"properties":{"id":{"type":"string"},"position":{"type":"number"},"assignee_type":{"type":"string","enum":["employee","employer","system"]}},"additionalProperties":false},{"type":"null"}]},"progress":{"type":"object","required":["percent","numerator","denominator"],"properties":{"percent":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false}},"tags":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"},"_tag":{"type":"string","enum":["Task"]}},"additionalProperties":false}},"components/schemas/TaskId":{"id":"components/schemas/TaskId","kind":"json-schema","title":"TaskId","data":{"type":"string","description":"Task Identifier","title":"TaskId","examples":["task_abc123def456"],"pattern":"^task_"}},"components/schemas/DuplicateTaskError":{"id":"components/schemas/DuplicateTaskError","kind":"json-schema","title":"DuplicateTaskError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["DuplicateTaskError"]}},"additionalProperties":false}},"components/schemas/ForbiddenError":{"id":"components/schemas/ForbiddenError","kind":"json-schema","title":"ForbiddenError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["ForbiddenError"]}},"additionalProperties":false}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"type":"object","required":["id","name","custom_attributes","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/JobId"},"name":{"type":"string"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"A job with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base job schema.","title":"Job"}},"components/schemas/Placement":{"id":"components/schemas/Placement","kind":"json-schema","title":"Placement","data":{"type":"object","required":["id","employee_id","employer_id","client_id","job_id","custom_attributes","created_at","missing_task_count","progress","form_requirements","suggested_tasks"],"properties":{"id":{"$ref":"#/components/schemas/PlacementId"},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},"client_id":{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},"job_id":{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"missing_task_count":{"type":"number"},"progress":{"type":"object","required":["forms_required","forms_completed"],"properties":{"forms_required":{"type":"number"},"forms_completed":{"type":"number"}},"additionalProperties":false},"form_requirements":{"type":"array","items":{"type":"object","required":["task_id","form","form_id","form_name","form_tags"],"properties":{"task_id":{"anyOf":[{"$ref":"#/components/schemas/TaskId"},{"type":"null"}]},"form":{"type":"object","required":["id","name","tags","custom_attributes"],"properties":{"id":{"$ref":"#/components/schemas/FormId"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":false},"form_id":{"$ref":"#/components/schemas/FormId"},"form_name":{"type":"string"},"form_tags":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"suggested_tasks":{"type":"array","items":{"type":"object","required":["form_id","form_name","task_id","form_tags"],"properties":{"form_id":{"$ref":"#/components/schemas/FormId"},"form_name":{"type":"string"},"task_id":{"anyOf":[{"$ref":"#/components/schemas/TaskId"},{"type":"null"}]},"form_tags":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"},"description":"A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.","title":"Placement"}},"components/schemas/PlacementId":{"id":"components/schemas/PlacementId","kind":"json-schema","title":"PlacementId","data":{"type":"string","description":"Placement Identifier","title":"PlacementId","examples":["pla_abc123def456"],"pattern":"^pla_"}},"components/schemas/PlacementConflictError":{"id":"components/schemas/PlacementConflictError","kind":"json-schema","title":"PlacementConflictError","data":{"type":"object","required":["message","meta","_tag"],"properties":{"message":{"type":"string"},"meta":{"type":"object","required":["placementId"],"properties":{"placementId":{"$ref":"#/components/schemas/PlacementId"}},"additionalProperties":false},"_tag":{"type":"string","enum":["PlacementConflictError"]}},"additionalProperties":false}},"components/schemas/Theme":{"id":"components/schemas/Theme","kind":"json-schema","title":"Theme","data":{"type":"object","required":["id","name","created_at","updated_at","_tag"],"properties":{"id":{"$ref":"#/components/schemas/ThemeId"},"name":{"type":"string","description":"a non empty string","title":"nonEmptyString","minLength":1},"light":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false},"dark":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"},"_tag":{"type":"string","enum":["Theme"]}},"additionalProperties":false}},"components/schemas/ThemeId":{"id":"components/schemas/ThemeId","kind":"json-schema","title":"ThemeId","data":{"type":"string","description":"Theme Identifier","title":"ThemeId","examples":["theme_abc123def456"],"pattern":"^theme_"}},"components/schemas/CustomProperty":{"id":"components/schemas/CustomProperty","kind":"json-schema","title":"CustomProperty","data":{"type":"object","required":["id","name","label","entity_type","scalar_type","path","auto_distribute_to_connected","is_sensitive_info","is_permission_scope","enum_options","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/CustomPropertyId"},"name":{"type":"string"},"label":{"type":"string"},"entity_type":{"type":"string","enum":["employee","employer","placement","form","client","job"]},"scalar_type":{"type":"string","enum":["string","boolean","date","datetime","integer","decimal","address","enum"]},"path":{"type":"string"},"auto_distribute_to_connected":{"type":"boolean"},"is_sensitive_info":{"type":"boolean"},"is_permission_scope":{"type":"boolean"},"enum_options":{"type":"array","items":{"type":"string"},"description":"Allowed values for enum type properties. Empty for other types."},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":false}},"components/schemas/CustomPropertyId":{"id":"components/schemas/CustomPropertyId","kind":"json-schema","title":"CustomPropertyId","data":{"type":"string","description":"Custom Property Identifier","title":"CustomPropertyId","examples":["cprop_abc123def456"],"pattern":"^cprop_"}},"components/schemas/CustomPropertyCreate":{"id":"components/schemas/CustomPropertyCreate","kind":"json-schema","title":"CustomPropertyCreate","data":{"type":"object","required":["name","label","entity_type","scalar_type"],"properties":{"name":{"type":"string"},"label":{"type":"string"},"entity_type":{"type":"string","enum":["employee","employer","placement","form","client","job"]},"scalar_type":{"type":"string","enum":["string","boolean","date","datetime","integer","decimal","address","enum"]},"auto_distribute_to_connected":{"type":"boolean","description":"Only applicable to platform organizations. When true, the new custom property is auto-copied to every connected organization.","default":false},"enum_options":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values for the property. Required when scalar_type is enum; not allowed for other types."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/MagicLinkRedirectPath":{"id":"components/schemas/MagicLinkRedirectPath","kind":"json-schema","title":"MagicLinkRedirectPath","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional redirect path within the dashboard (must be a relative path starting with '/' and cannot contain external URLs). Examples: /dashboard, /employees/ee_123"},"children":[]}]}]}]}},"components/schemas/PersistedFile":{"id":"components/schemas/PersistedFile","kind":"json-schema","title":"PersistedFile","data":{"type":"string","format":"binary"}},"components/schemas/SubtaskId":{"id":"components/schemas/SubtaskId","kind":"json-schema","title":"SubtaskId","data":{"type":"string","description":"Subtask Identifier","title":"SubtaskId","examples":["subtask_abc123def456"],"pattern":"^subtask_"}},"components/schemas/UploadFilesResponse":{"id":"components/schemas/UploadFilesResponse","kind":"json-schema","title":"UploadFilesResponse","data":{"type":"object","required":["files"],"properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/UploadedFile"}}},"additionalProperties":false}},"components/schemas/UploadedFile":{"id":"components/schemas/UploadedFile","kind":"json-schema","title":"UploadedFile","data":{"type":"object","required":["id","key","name","type","size","checksum"],"properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"checksum":{"type":"string"}},"additionalProperties":false}},"components/schemas/TaskChangeRequestCreated":{"id":"components/schemas/TaskChangeRequestCreated","kind":"json-schema","title":"TaskChangeRequestCreated","data":{"type":"object","required":["_tag"],"properties":{"_tag":{"type":"string","enum":["created"]}},"additionalProperties":false}},"components/schemas/TaskChangeRequestSkipped":{"id":"components/schemas/TaskChangeRequestSkipped","kind":"json-schema","title":"TaskChangeRequestSkipped","data":{"type":"object","required":["_tag"],"properties":{"_tag":{"type":"string","enum":["skipped"]}},"additionalProperties":false}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","required":["id","email","external_id","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/UserId"},"email":{"type":"string"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":false}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","description":"User Identifier","title":"UserId","examples":["user_abc123def456"],"pattern":"^user_"}},"components/schemas/WorkosUserCreationError":{"id":"components/schemas/WorkosUserCreationError","kind":"json-schema","title":"WorkosUserCreationError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["WorkosUserCreationError"]}},"additionalProperties":false}},"components/schemas/WorkosUserDeletionError":{"id":"components/schemas/WorkosUserDeletionError","kind":"json-schema","title":"WorkosUserDeletionError","data":{"type":"object","required":["message","_tag"],"properties":{"message":{"type":"string"},"_tag":{"type":"string","enum":["WorkosUserDeletionError"]}},"additionalProperties":false}},"components/schemas/UserGroup":{"id":"components/schemas/UserGroup","kind":"json-schema","title":"UserGroup","data":{"type":"object","required":["id","name","created_at","updated_at"],"properties":{"id":{"$ref":"#/components/schemas/UserGroupId"},"name":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"}},"additionalProperties":false}},"components/schemas/UserGroupId":{"id":"components/schemas/UserGroupId","kind":"json-schema","title":"UserGroupId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User group identifier. Pass these values in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_group_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a user."},"children":[]}]}]}],"title":"UserGroupId","examples":["ug_abc123def456"],"pattern":"^ug_"}},"components/schemas/Webhook":{"id":"components/schemas/Webhook","kind":"json-schema","title":"Webhook","data":{"type":"object","required":["id","url","token","description","created_at","updated_at","last_used_at","subscribed_events"],"properties":{"id":{"$ref":"#/components/schemas/WebhookId"},"url":{"type":"string"},"token":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"$ref":"#/components/schemas/DateTimeUtc"},"updated_at":{"$ref":"#/components/schemas/DateTimeUtc"},"last_used_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"subscribed_events":{"type":"array","items":{"type":"string","enum":["employee.created","employee.updated","employee.deleted","employer.created","employer.updated","employer.deleted","client.created","client.updated","client.deleted","job.created","job.updated","job.deleted","task.created","task.updated","task.deleted","task.form_pdf_generated","placement.created","placement.updated","placement.deleted","automation.evaluation_failed"]}}},"additionalProperties":false}},"components/schemas/WebhookId":{"id":"components/schemas/WebhookId","kind":"json-schema","title":"WebhookId","data":{"type":"string","description":"Webhook Identifier","title":"WebhookId","examples":["we_abc123def456"],"pattern":"^we_"}},"schema_89":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NumberFromString"}],"description":"1-based page number. There is no upper bound; values below 1 are clamped to 1.","title":"page"},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/NumberFromString"}],"title":"between(1, 100)","description":"a number between 1 and 100"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"string"},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DateTimeUtc"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/HttpApiDecodeError"},{"$ref":"#/components/schemas/BadRequestError"}]},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ClientId"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"name":{"type":"string"},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"anyOf":[{"anyOf":[{"type":"object","required":["component"],"properties":{"component":{"type":"string","enum":["employees/list"]},"filters":{"type":"object","required":[],"properties":{"after":{"type":"string"},"before":{"type":"string"},"limit":{"type":"string"},"order_by":{"type":"string"},"order_dir":{"type":"string"},"employee_id":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"custom_attributes":{"type":"string"},"system_attributes":{"type":"string"},"custom_view_id":{"type":"string"},"created_at_from":{"type":"string"},"created_at_to":{"type":"string"},"latest_task_updated_at_from":{"type":"string"},"latest_task_updated_at_to":{"type":"string"},"next_task_due_at_from":{"type":"string"},"next_task_due_at_to":{"type":"string"},"progress_min":{"type":"string"},"progress_max":{"type":"string"},"placements_count_min":{"type":"string"},"placements_count_max":{"type":"string"}},"additionalProperties":false},"options":{"type":"object","required":[],"properties":{"redirect_url_expires_in":{"type":"number"},"session_expires_in":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false},{"type":"object","required":["component"],"properties":{"component":{"type":"string","enum":["everify/cases"]},"filters":{"type":"object","required":[],"properties":{"page":{"type":"string"},"per_page":{"type":"string"},"case_statuses":{"type":"string"},"case_tracking":{"type":"string"}},"additionalProperties":false},"options":{"type":"object","required":[],"properties":{"redirect_url_expires_in":{"type":"number"},"session_expires_in":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false}]},{"type":"object","required":["component","employee_id"],"properties":{"component":{"type":"string","enum":["employee/tasks"]},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"filters":{"type":"object","required":[],"properties":{"task_id":{"type":"string"},"employee_id":{"type":"string"},"employer_id":{"type":"string"},"client_id":{"type":"string"},"job_id":{"type":"string"},"form_id":{"type":"string"},"employee_cv_uid":{"type":"string"},"progress":{"type":"string"},"next_action":{"type":"string"},"custom_view_id":{"type":"string"},"assignee":{"type":"string"},"order_by":{"type":"string"},"order_dir":{"type":"string"},"after":{"type":"string"},"before":{"type":"string"},"limit":{"type":"string"}},"additionalProperties":false},"options":{"type":"object","required":[],"properties":{"redirect_url_expires_in":{"type":"number"},"session_expires_in":{"type":"number"}},"additionalProperties":false}},"additionalProperties":false}]},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"object","required":["component","redirect_url","code"],"properties":{"component":{"type":"string","enum":["employees/list","everify/cases","employee/tasks"]},"redirect_url":{"type":"string"},"code":{"type":"string"}},"additionalProperties":false},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedOrganization"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"object","required":["name","business_email","default_language","supported_languages"],"properties":{"name":{"type":"string"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_email":{"type":"string"},"candidate_support_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_language":{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]},"supported_languages":{"type":"array","items":{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]}},"address":{"anyOf":[{"type":"object","required":["street","city","state","country","full_address"],"properties":{"street":{"type":"string"},"secondary":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"type":"string","enum":["AND","ARE","ATG","AIA","ALB","ARM","AGO","ATA","ARG","ASM","AUT","AUS","ABW","ALA","AZE","BIH","BRB","BGD","BEL","BFA","BGR","BHR","BDI","BEN","BLM","BMU","BRN","BOL","BES","BRA","BHS","BTN","BVT","BWA","BLR","BLZ","CAN","CCK","COD","CAF","COG","CHE","CIV","COK","CHL","CHN","CMR","COL","CRI","CPV","CUW","CXR","CYP","CZE","DEU","DJI","DNK","DMA","DOM","DZA","ECU","EST","EGY","ESH","ERI","ESP","ETH","FIN","FJI","FLK","FSM","FRO","FRA","GAB","GBR","GRD","GEO","GUF","GGY","GHA","GIB","GRL","GMB","GIN","GLP","GNQ","GRC","SGS","GTM","GUM","GNB","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IRL","ISR","IMN","IND","IOT","IRQ","ISL","ITA","JEY","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA","KOR","KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU","LUX","LVA","LBY","MAR","MCO","MDA","MNE","MAF","MDG","MHL","MKD","MLI","MMR","MNG","MAC","MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM","NCL","NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NIU","NZL","OMN","PAN","PER","PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT","PLW","PRY","QAT","REU","ROU","SRB","RUS","RWA","SAU","SLB","SYC","SWE","SGP","SHN","SVN","SJM","SVK","SLE","SMR","SEN","SOM","SUR","SSD","STP","SLV","SXM","SWZ","TCA","TCD","ATF","TGO","THA","TJK","TKL","TLS","TKM","TUN","TON","TUR","TTO","TUV","TWN","TZA","UKR","UGA","UMI","USA","URY","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","MYT","ZAF","ZMB","ZWE"]},"full_address":{"type":"string"}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string","description":"Connected Organization Identifier","title":"ConnectedOrganizationId"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"name":{"type":"string"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"business_email":{"type":"string"},"candidate_support_email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_language":{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]},"supported_languages":{"type":"array","items":{"type":"string","enum":["af","ak","sq","am","ar","hy","as","ay","az","bm","bn","eu","be","bho","bs","bg","my","ca","ceb","ckb","zh-CN","zh-TW","co","hr","cs","da","dv","doi","nl","en","eo","et","ee","fil","fi","fr","gl","lg","ka","de","el","gu","ht","ha","haw","he","hi","hmn","hu","is","ig","ilo","id","ga","it","ja","jv","kn","kk","km","rw","kok","ko","kri","ku","ky","lo","la","lv","ln","lt","lb","mk","mai","mg","ms","ml","mt","mni-Mtei","mi","mr","lus","mn","ne","nso","no","ny","or","om","ps","fa","pl","pt","pa","qu","ro","ru","sm","sa","gd","sr","sn","sd","si","sk","sl","so","st","es","su","sw","sv","tg","ta","tt","te","th","ti","ts","tr","tk","uk","ur","ug","uz","vi","cy","fy","xh","yi","yo","zu"]}},"address":{"anyOf":[{"type":"object","required":["street","city","state","country","full_address"],"properties":{"street":{"type":"string"},"secondary":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"type":"string","enum":["AND","ARE","ATG","AIA","ALB","ARM","AGO","ATA","ARG","ASM","AUT","AUS","ABW","ALA","AZE","BIH","BRB","BGD","BEL","BFA","BGR","BHR","BDI","BEN","BLM","BMU","BRN","BOL","BES","BRA","BHS","BTN","BVT","BWA","BLR","BLZ","CAN","CCK","COD","CAF","COG","CHE","CIV","COK","CHL","CHN","CMR","COL","CRI","CPV","CUW","CXR","CYP","CZE","DEU","DJI","DNK","DMA","DOM","DZA","ECU","EST","EGY","ESH","ERI","ESP","ETH","FIN","FJI","FLK","FSM","FRO","FRA","GAB","GBR","GRD","GEO","GUF","GGY","GHA","GIB","GRL","GMB","GIN","GLP","GNQ","GRC","SGS","GTM","GUM","GNB","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IRL","ISR","IMN","IND","IOT","IRQ","ISL","ITA","JEY","JAM","JOR","JPN","KEN","KGZ","KHM","KIR","COM","KNA","KOR","KWT","CYM","KAZ","LAO","LBN","LCA","LIE","LKA","LBR","LSO","LTU","LUX","LVA","LBY","MAR","MCO","MDA","MNE","MAF","MDG","MHL","MKD","MLI","MMR","MNG","MAC","MNP","MTQ","MRT","MSR","MLT","MUS","MDV","MWI","MEX","MYS","MOZ","NAM","NCL","NER","NFK","NGA","NIC","NLD","NOR","NPL","NRU","NIU","NZL","OMN","PAN","PER","PYF","PNG","PHL","PAK","POL","SPM","PCN","PRI","PSE","PRT","PLW","PRY","QAT","REU","ROU","SRB","RUS","RWA","SAU","SLB","SYC","SWE","SGP","SHN","SVN","SJM","SVK","SLE","SMR","SEN","SOM","SUR","SSD","STP","SLV","SXM","SWZ","TCA","TCD","ATF","TGO","THA","TJK","TKL","TLS","TKM","TUN","TON","TUR","TTO","TUV","TWN","TZA","UKR","UGA","UMI","USA","URY","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","MYT","ZAF","ZMB","ZWE"]},"full_address":{"type":"string"}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Employee"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}]},"social_security_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_middle_name":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EmployeeId"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}]},"social_security_number":{"anyOf":[{"type":"string"},{"type":"null"}]},"has_middle_name":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"string","enum":["employee","employer"],"description":"Type of assignee for onboarding tasks. Defaults to \"employee\"."},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"string","description":"Scopes the link to a single placement: the candidate sees only that placement's tasks.","title":"PlacementId","examples":["pla_abc123def456"],"pattern":"^pla_"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field should only be set to true when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. Tasks will be automatically sorted to satisfy their form stages' sequence."},"children":[]}]}]}]},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","description":"Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability."},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","description":"Redirect to URL to send the user after onboarding is complete"},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"string","description":"Custom theme for the onboarding form"},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"boolean","description":"Whether OTP verification is required before accessing the onboarding form"},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","description":"Comma-separated list of allowed OTP delivery methods (sms, email)"},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"}},"additionalProperties":false},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","required":["target_employee_id"],"properties":{"target_employee_id":{"$ref":"#/components/schemas/EmployeeId"}},"additionalProperties":false},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Employer"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"employee_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity_structure":{"anyOf":[{"type":"string","enum":["sole_proprietorship","partnership","llc","corporation","nonprofit","cooperative","professional_corporation"],"description":"Legal entity structure of the employer","title":"EntityStructure"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"active_theme_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EmployerId"},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"name":{"type":"string"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}]},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"employee_count":{"anyOf":[{"type":"number"},{"type":"null"}]},"entity_structure":{"anyOf":[{"type":"string","enum":["sole_proprietorship","partnership","llc","corporation","nonprofit","cooperative","professional_corporation"],"description":"Legal entity structure of the employer","title":"EntityStructure"},{"type":"null"}]},"naics_code":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"active_theme_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EventCursor"},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"string","description":"a number between 1 and 1000","title":"between(1, 1000)"},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of event types to return, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.created,job.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["job.created","job.created,job.updated"]},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of object families to return every event for, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job.deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["job","job,task"]},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"$ref":"#/components/schemas/EventId"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"$ref":"#/components/schemas/FileId"},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Form"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"$ref":"#/components/schemas/FormId"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"$ref":"#/components/schemas/JobId"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","enum":["requires_action","completed","expired"]},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","enum":["true","false","True","False"]},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"object","required":["form_id","employee_id"],"properties":{"form_id":{"$ref":"#/components/schemas/FormId"},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},{"type":"null"}]},"client_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},{"type":"null"}]},"job_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},{"type":"null"}]},"placement_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/PlacementId"},{"type":"null"}]},{"type":"null"}]},"expired_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"due_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_scheduled_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_allowed_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]}},"additionalProperties":false},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TaskId"},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"expired_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_scheduled_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"deletion_allowed_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]},"due_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}]}},"additionalProperties":false},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/Forbidden"},{"$ref":"#/components/schemas/ForbiddenError"}]},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","required":["fields"],"properties":{"fields":{"type":"array","items":{"type":"object","required":["type","path","label","value","submitted_at"],"properties":{"type":{"type":"string"},"path":{"type":"string"},"label":{"type":"object","required":["en"],"properties":{"en":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Label for the field, in english (if available)"}},"additionalProperties":false},"value":{"$id":"/schemas/any","description":"The value of the field","title":"any"},"submitted_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeUtc"},{"type":"null"}],"description":"The time when the value was submitted for the field, null if there is no submission value."}},"additionalProperties":false}}},"additionalProperties":false},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","required":["fields"],"properties":{"fields":{"type":"array","items":{"type":"object","required":["path","value"],"properties":{"path":{"type":"string"},"value":{"$id":"/schemas/any","description":"The value of the field","title":"any"}},"additionalProperties":false}}},"additionalProperties":false},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"null"},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"string","enum":["employee","employer"]},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Job"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"name":{"type":"string"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Placement"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"object","required":["employee_id"],"properties":{"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},{"type":"null"}]},"client_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},{"type":"null"}]},"job_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"create_tasks":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PlacementId"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"employer_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},{"type":"null"}]},"client_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},{"type":"null"}]},"job_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"},"create_tasks":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"object","required":["employee_id"],"properties":{"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},{"type":"null"}]},"client_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},{"type":"null"}]},"job_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},{"type":"null"}]},"custom_attributes":{"$ref":"#/components/schemas/CustomAttributes"}},"additionalProperties":{"$ref":"#/components/schemas/ScalarValueUnknown"}},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"object","required":["employee_id"],"properties":{"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"employer_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/EmployerId"},{"type":"null"}]},{"type":"null"}]},"client_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ClientId"},{"type":"null"}]},{"type":"null"}]},"job_id":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/JobId"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","required":["form_id","name","rules"],"properties":{"form_id":{"$ref":"#/components/schemas/FormId"},"name":{"type":"string"},"rules":{"$id":"/schemas/unknown","title":"unknown"}},"additionalProperties":false}},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Theme"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"a non empty string","title":"nonEmptyString","minLength":1},"light":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false},"dark":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ThemeId"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"a non empty string","title":"nonEmptyString","minLength":1},"light":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false},"dark":{"type":"object","required":[],"properties":{"logo":{"type":"string"},"show_header":{"type":"boolean"},"show_form_name":{"type":"boolean"},"show_updated_fields_count":{"type":"boolean"},"next_button_text":{"type":"string"},"back_button_text":{"type":"string"},"custom_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"custom_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"primary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_background":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"secondary_foreground":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"progress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex Theme Color (must be a valid hex code like #FFF or #FFFFFF)"},"children":[]}]}]}],"title":"ThemeColor","examples":["#FFF","#FFFFFF"],"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$"},"radius":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"string","enum":["employee","employer","placement","form","client","job"]},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"string","enum":["active","deprecated"]},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomProperty"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CustomPropertyId"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","required":["expire_in"],"properties":{"user_email":{"type":"string","format":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User email address. Onboarded stores user emails in lowercase, and this value will be lowercased to match against existing users. If not provided, user_external_id is required and must identify a unique user."},"children":[]}]}]}]},"user_external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom identifier provided upon user creation. Can be provided with or without user_email. If user_email is omitted, however, this field must uniquely identify a user. An error will be returned if multiple users hold the same external_id."},"children":[]}]}]}]},"expire_in":{"type":"integer","description":"a number between 1 and 86400","title":"between(1, 86400)","minimum":1,"maximum":86400},"redirect_path":{"anyOf":[{"$ref":"#/components/schemas/MagicLinkRedirectPath"},{"type":"null"}]}},"additionalProperties":false},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","required":["url","expire_at","redirect_path_deprecation_deadline","redirect_path_deprecation_note"],"properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a string matching the pattern ^https?://.+"},"children":[]}]}]}],"pattern":"^https?:\\/\\/.+"},"expire_at":{"type":"string"},"redirect_path_deprecation_deadline":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the redirect_path parameter will become invalid and stop working"},"children":[]}]}]}]},"redirect_path_deprecation_note":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about what to use instead of the deprecated redirect_path parameter"},"children":[]}]}]}]}},"additionalProperties":false},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SubtaskId"},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","required":["files"],"properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/PersistedFile"}}},"additionalProperties":false},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"starting_section_id":{"type":"string"}},"additionalProperties":false},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"$ref":"#/components/schemas/NumberFromString"},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","required":["email","user_group_ids"],"properties":{"email":{"type":"string"},"password":{"anyOf":[{"type":"string","description":"Password must be at least 8 characters and contain uppercase, lowercase, and numbers.","title":"minLength(8)","minLength":8,"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)"},{"type":"null"}]},"email_verified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"user_group_ids":{"type":"array","items":{"type":"string"}},"external_id":{"anyOf":[{"type":"string","description":"Optional field to store a customer-provided identifier for the user. Onboarded does not validate uniqueness of this field. Customers who intend to use this field with magic links should ensure this field holds unique values."},{"type":"null"}]}},"additionalProperties":false},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/HttpApiDecodeError"},{"$ref":"#/components/schemas/WorkosUserCreationError"},{"$ref":"#/components/schemas/BadRequestError"}]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserId"},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"external_id":{"anyOf":[{"type":"string","description":"Optional field to store a customer-provided identifier for the user. Onboarded does not validate uniqueness of this field. Customers who intend to use this field with magic links should ensure this field holds unique values."},{"type":"null"}]}},"additionalProperties":false},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/HttpApiDecodeError"},{"$ref":"#/components/schemas/WorkosUserDeletionError"}]},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case-insensitive substring match on the group name. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Admins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"object","required":["data","total","current_page","per_page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"total":{"type":"number"},"current_page":{"type":"number"},"per_page":{"type":"number"},"total_pages":{"type":"number"}},"additionalProperties":false},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string"},"description":{"type":"string"},"subscribed_events":{"type":"array","items":{"type":"string","enum":["employee.created","employee.updated","employee.deleted","employer.created","employer.updated","employer.deleted","client.created","client.updated","client.deleted","job.created","job.updated","job.deleted","task.created","task.updated","task.deleted","task.form_pdf_generated","placement.created","placement.updated","placement.deleted","automation.evaluation_failed"]}}},"additionalProperties":false},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WebhookId"},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","required":[],"properties":{"description":{"type":"string"},"subscribed_events":{"type":"array","items":{"type":"string","enum":["employee.created","employee.updated","employee.deleted","employer.created","employer.updated","employer.deleted","client.created","client.updated","client.deleted","job.created","job.updated","job.deleted","task.created","task.updated","task.deleted","task.form_pdf_generated","placement.created","placement.updated","placement.deleted","automation.evaluation_failed"]}}},"additionalProperties":false},"id":"schema_177"}},"exampleStore":{},"securitySchemeStore":{"form_session":{"id":"form_session","type":"http","scheme":"bearer"},"user_session":{"id":"user_session","type":"apiKey","in":"cookie","paramName":"__session"},"component_session":{"id":"component_session","type":"apiKey","in":"cookie","paramName":"__component"},"component_token":{"id":"component_token","type":"apiKey","in":"header","paramName":"x-component-auth-token"},"api_token":{"id":"api_token","type":"http","scheme":"bearer"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://app.onboarded.com","description":"Onboarded Production Server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Onboarded Public API","description":"Public API for Customers, Partners, and Integrations"}},"baseSlug":"/openapi","routesMapping":{}}