{"items":[{"type":"link","label":"Quinyx API","link":"/api/v3/specs/quinyx-public-api-v3","routeSlug":"/api/v3/specs/quinyx-public-api-v3","content":{"contentType":"overview","meta":{"name":"Quinyx API"},"children":[{"nodeType":"container","panels":[{"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":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Quinyx API (v3)","showPageActions":true}],"sectionId":"/api/v3/specs/quinyx-public-api-v3"}]}]}},{"type":"separator","label":"OAuth","content":null},{"type":"group","label":"Access Token","link":"/api/v3/specs/quinyx-public-api-v3/access-token","routeSlug":"/api/v3/specs/quinyx-public-api-v3/access-token","items":[{"label":"Obtain access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/access-token/gettoken","routeSlug":"/api/v3/specs/quinyx-public-api-v3/access-token/gettoken","metadata":{"seo":{"title":"Obtain access token","description":"Operation returns the OAuth2 token that can be used in API calls"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getToken","name":"Obtain access token","isWebhook":false,"pointer":"/paths/~1oauth~1v3~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtain access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Operation returns the OAuth2 token that can be used in API calls"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenRequest"}},"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenRequest","pointer":"/paths/~1oauth~1v3~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth/v3/token","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/oauth/v3/token","href":"access-token/gettoken","openApiOperationId":"getToken","summary":"Obtain access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenRequest","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenResponse"}},"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1oauth~1v3~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest-api-uaa_OAuth2TokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2TokenResponse"}}},{"code":"400","schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","exampleIds":["paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/oauth/v3/token"}],"content":{"contentType":"group","meta":{"name":"Access Token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Token","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth/v3/token","summary":"Obtain access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/access-token/gettoken","deprecated":false}]}]}]}]}},{"type":"separator","label":"Organization","content":null},{"type":"group","label":"Group","link":"/api/v3/specs/quinyx-public-api-v3/group","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group","items":[{"label":"Get a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/group/getgroup","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group/getgroup","metadata":{"seo":{"title":"Get a group","description":"Returns a group by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Get a group","isWebhook":false,"pointer":"/paths/~1organization~1v3~1groups~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a group by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:groups:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization/v3/groups/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:groups:read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/organization/v3/groups/{id}","href":"group/getgroup","openApiOperationId":"getGroup","summary":"Get a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}},"schemaId":"components/schemas/organisation_GroupResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/organisation_GroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/groups/{id}"},{"label":"Update a group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/group/updategroup","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group/updategroup","metadata":{"seo":{"title":"Update a group","description":"Updates the specified group with the provided attributes and returns the updated group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroup","name":"Update a group","isWebhook":false,"pointer":"/paths/~1organization~1v3~1groups~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the specified group with the provided attributes and returns the updated group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:groups:update"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"schemaId":"components/schemas/organisation_CreateGroupRequest","pointer":"/paths/~1organization~1v3~1groups~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organization/v3/groups/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:groups:update"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/organization/v3/groups/{id}","href":"group/updategroup","openApiOperationId":"updateGroup","summary":"Update a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/organisation_CreateGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}},"schemaId":"components/schemas/organisation_GroupResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/organisation_GroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}}},{"code":"400","schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/groups/{id}"},{"label":"Deletes a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/group/deletegroup","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group/deletegroup","metadata":{"seo":{"title":"Deletes a group","description":"Permanently deletes the specified group and all associated data, including but not limited to employees, shifts, and punches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Deletes a group","isWebhook":false,"pointer":"/paths/~1organization~1v3~1groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes the specified group and all associated data, including but not limited to employees, shifts, and punches."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:groups:delete"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_141","required":true}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organization/v3/groups/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:groups:delete"]}],"responseCodes":["202","401","403","404","500"],"pointer":"/organization/v3/groups/{id}","href":"group/deletegroup","openApiOperationId":"deleteGroup","summary":"Deletes a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/groups/{id}"},{"label":"List groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/group/getgroups","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group/getgroups","metadata":{"seo":{"title":"List groups","description":"Returns a paginated list of groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroups","name":"List groups","isWebhook":false,"pointer":"/paths/~1organization~1v3~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of groups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:groups:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_143","description":"Cursor for the next page of results."},{"name":"pageSize","in":"query","schemaId":"schema_144","description":"Maximum number of items to return."},{"name":"idIn","in":"query","schemaId":"schema_145","description":"Filter by id (IN). Supports external ids of types: xrefId"}],"pointer":"/paths/~1organization~1v3~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization/v3/groups","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[{"name":"pageToken","in":"query","required":false,"example":"eyJpZCI6MTAwfQ","schemaId":"schema_143"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_144"},{"name":"idIn","in":"query","schemaId":"schema_145","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:groups:read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/organization/v3/groups","href":"group/getgroups","openApiOperationId":"getGroups","summary":"List groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_CursorPageGroupResponse"}},"schemaId":"components/schemas/organisation_CursorPageGroupResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/organisation_CursorPageGroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_CursorPageGroupResponse"}}},{"code":"400","schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/groups"},{"label":"Create a group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/group/creategroup","routeSlug":"/api/v3/specs/quinyx-public-api-v3/group/creategroup","metadata":{"seo":{"title":"Create a group","description":"Creates a new group and returns the created group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroup","name":"Create a group","isWebhook":false,"pointer":"/paths/~1organization~1v3~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new group and returns the created group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:groups:create"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"schemaId":"components/schemas/organisation_CreateGroupRequest","pointer":"/paths/~1organization~1v3~1groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organization/v3/groups","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:groups:create"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/organization/v3/groups","href":"group/creategroup","openApiOperationId":"createGroup","summary":"Create a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/organisation_CreateGroupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/organisation_CreateGroupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}},"schemaId":"components/schemas/organisation_GroupResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/organisation_GroupResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/organisation_GroupResponse"}}},{"code":"400","schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_142","exampleIds":["paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/groups"}],"content":{"contentType":"group","meta":{"name":"Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organization/v3/groups/{id}","summary":"Get a group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/getgroup","deprecated":false},{"title":"/organization/v3/groups/{id}","summary":"Update a group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/group/updategroup","deprecated":false},{"title":"/organization/v3/groups/{id}","summary":"Deletes a group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/group/deletegroup","deprecated":false},{"title":"/organization/v3/groups","summary":"List groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/getgroups","deprecated":false},{"title":"/organization/v3/groups","summary":"Create a group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/creategroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Role","link":"/api/v3/specs/quinyx-public-api-v3/role","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role","items":[{"label":"List roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role/getroles","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role/getroles","metadata":{"seo":{"title":"List roles","description":"Returns a paginated list of roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoles","name":"List roles","isWebhook":false,"pointer":"/paths/~1organization~1v3~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of roles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:roles:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_143","description":"Cursor for the next page of results."},{"name":"pageSize","in":"query","schemaId":"schema_144","description":"Maximum number of items to return."}],"pointer":"/paths/~1organization~1v3~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization/v3/roles","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[{"name":"pageToken","in":"query","required":false,"example":"eyJpZCI6MTAwfQ","schemaId":"schema_143"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_144"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:roles:read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/organization/v3/roles","href":"role/getroles","openApiOperationId":"getRoles","summary":"List roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_CursorPageRoleResponse"}},"schemaId":"components/schemas/security_CursorPageRoleResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_146","exampleIds":["paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security_CursorPageRoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_CursorPageRoleResponse"}}},{"code":"400","schemaId":"schema_146","exampleIds":["paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/roles"},{"label":"Get a role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role/getrole","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role/getrole","metadata":{"seo":{"title":"Get a role","description":"Returns a role by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRole","name":"Get a role","isWebhook":false,"pointer":"/paths/~1organization~1v3~1roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a role by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["organization:roles:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_147","required":true}],"pointer":"/paths/~1organization~1v3~1roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organization/v3/roles/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_147"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["organization:roles:read"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/organization/v3/roles/{id}","href":"role/getrole","openApiOperationId":"getRole","summary":"Get a role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleResponse"}},"schemaId":"components/schemas/security_RoleResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1organization~1v3~1roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security_RoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleResponse"}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/organization/v3/roles/{id}"}],"content":{"contentType":"group","meta":{"name":"Role"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organization/v3/roles","summary":"List roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/role/getroles","deprecated":false},{"title":"/organization/v3/roles/{id}","summary":"Get a role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/role/getrole","deprecated":false}]}]}]}]}},{"type":"separator","label":"HR","content":null},{"type":"group","label":"Employee","link":"/api/v3/specs/quinyx-public-api-v3/employee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee","items":[{"label":"Get an employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/getemployee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/getemployee","metadata":{"seo":{"title":"Get an employee","description":"Retrieves a single employee by its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployee","name":"Get an employee","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single employee by its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_148","description":"Employee identifier","required":true,"examples":{"internal-id":{"summary":"Internal ID","description":"The internal ID of the resource","value":"12345"},"badge-number":{"summary":"Badge number","value":"badgeNumber:B001"}}}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hr/v3/employees/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:read"]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/hr/v3/employees/{id}","href":"employee/getemployee","openApiOperationId":"getEmployee","summary":"Get an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}},"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/employee_IntegrationEmployeeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}}},{"code":"400","schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees/{id}"},{"label":"Update an employee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/updateemployee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/updateemployee","metadata":{"seo":{"title":"Update an employee","description":"Updates the specified employee with the provided attributes and returns it"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmployee","name":"Update an employee","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees~1{id}/put","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":"markdoc","content":"Updates the specified employee with the provided attributes and returns it"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:update"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_148","description":"Employee identifier","required":true,"examples":{"internal-id":{"summary":"Internal ID","description":"The internal ID of the resource","value":"12345"},"badge-number":{"summary":"Badge number","value":"badgeNumber:B001"}}}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeUpdateRequest"}},"schemaId":"components/schemas/employee_IntegrationEmployeeUpdateRequest","pointer":"/paths/~1hr~1v3~1employees~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hr/v3/employees/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:update"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeUpdateRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/hr/v3/employees/{id}","href":"employee/updateemployee","openApiOperationId":"updateEmployee","summary":"Update an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/employee_IntegrationEmployeeUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}},"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/employee_IntegrationEmployeeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}}},{"code":"400","schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees/{id}"},{"label":"Delete an employee","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/deleteemployee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/deleteemployee","metadata":{"seo":{"title":"Delete an employee","description":"Permanently deletes an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployee","name":"Delete an employee","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees~1{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":"markdoc","content":"Permanently deletes an employee"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:delete"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_148","description":"Employee identifier","required":true,"examples":{"internal-id":{"summary":"Internal ID","description":"The internal ID of the resource","value":"12345"},"badge-number":{"summary":"Badge number","value":"badgeNumber:B001"}}}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hr/v3/employees/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:delete"]}],"responseCodes":["200","401","403","404","500"],"pointer":"/hr/v3/employees/{id}","href":"employee/deleteemployee","openApiOperationId":"deleteEmployee","summary":"Delete an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees/{id}"},{"label":"Partially update an employee","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/patchemployee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/patchemployee","metadata":{"seo":{"title":"Partially update an employee","description":"Partially updates the specified employee with the provided attributes and returns it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEmployee","name":"Partially update an employee","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates the specified employee with the provided attributes and returns it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:update"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_148","description":"Employee identifier","required":true,"examples":{"internal-id":{"summary":"Internal ID","description":"The internal ID of the resource","value":"12345"},"badge-number":{"summary":"Badge number","value":"badgeNumber:B001"}}}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeePatchRequest"}},"schemaId":"components/schemas/employee_IntegrationEmployeePatchRequest","pointer":"/paths/~1hr~1v3~1employees~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hr/v3/employees/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"12345","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:update"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeePatchRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/hr/v3/employees/{id}","href":"employee/patchemployee","openApiOperationId":"patchEmployee","summary":"Partially update an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/employee_IntegrationEmployeePatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeePatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}},"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/employee_IntegrationEmployeeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}}},{"code":"400","schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees/{id}"},{"label":"List employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/getemployees","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/getemployees","metadata":{"seo":{"title":"List employees","description":"Returns a paginated list of employees."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployees","name":"List employees","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of employees."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"idIn","in":"query","schemaId":"schema_150"},{"name":"pageToken","in":"query","schemaId":"schema_143","description":"Cursor for the next page of results."},{"name":"pageSize","in":"query","schemaId":"schema_144","description":"Maximum number of items to return."}],"pointer":"/paths/~1hr~1v3~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hr/v3/employees","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[{"name":"idIn","in":"query","required":false,"schemaId":"schema_150"},{"name":"pageToken","in":"query","required":false,"example":"eyJpZCI6MTAwfQ","schemaId":"schema_143"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_144"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/hr/v3/employees","href":"employee/getemployees","openApiOperationId":"getEmployees","summary":"List employees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_CursorPageIntegrationEmployeeResponse"}},"schemaId":"components/schemas/employee_CursorPageIntegrationEmployeeResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/employee_CursorPageIntegrationEmployeeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_CursorPageIntegrationEmployeeResponse"}}},{"code":"400","schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees"},{"label":"Create an employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/employee/createemployee","routeSlug":"/api/v3/specs/quinyx-public-api-v3/employee/createemployee","metadata":{"seo":{"title":"Create an employee","description":"Creates and returns the created employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmployee","name":"Create an employee","isWebhook":false,"pointer":"/paths/~1hr~1v3~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates and returns the created employee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:employees:create"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeCreateRequest"}},"schemaId":"components/schemas/employee_IntegrationEmployeeCreateRequest","pointer":"/paths/~1hr~1v3~1employees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hr/v3/employees","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:employees:create"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeCreateRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/hr/v3/employees","href":"employee/createemployee","openApiOperationId":"createEmployee","summary":"Create an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/employee_IntegrationEmployeeCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}},"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/employee_IntegrationEmployeeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/employee_IntegrationEmployeeResponse"}}},{"code":"400","schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_149","exampleIds":["paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/employees"}],"content":{"contentType":"group","meta":{"name":"Employee"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employee","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hr/v3/employees/{id}","summary":"Get an employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee/getemployee","deprecated":false},{"title":"/hr/v3/employees/{id}","summary":"Update an employee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employee/updateemployee","deprecated":false},{"title":"/hr/v3/employees/{id}","summary":"Delete an employee","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employee/deleteemployee","deprecated":false},{"title":"/hr/v3/employees/{id}","summary":"Partially update an employee","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/employee/patchemployee","deprecated":false},{"title":"/hr/v3/employees","summary":"List employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee/getemployees","deprecated":false},{"title":"/hr/v3/employees","summary":"Create an employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employee/createemployee","deprecated":false}]}]}]}]}},{"type":"group","label":"Role Assignment","link":"/api/v3/specs/quinyx-public-api-v3/role-assignment","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role-assignment","items":[{"label":"List role assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role-assignment/listroleassignments","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role-assignment/listroleassignments","metadata":{"seo":{"title":"List role assignments","description":"Returns a paginated list of role assignments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRoleAssignments","name":"List role assignments","isWebhook":false,"pointer":"/paths/~1hr~1v3~1role-assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List role assignments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of role assignments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:role-assignments:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_143","description":"Cursor for the next page of results."},{"name":"pageSize","in":"query","schemaId":"schema_144","description":"Maximum number of items to return."},{"name":"idIn","in":"query","schemaId":"schema_151","description":"Filter by id (IN)"},{"name":"employeeIdIn","in":"query","schemaId":"schema_152","description":"Filter by employeeId (IN)"},{"name":"groupIdIn","in":"query","schemaId":"schema_153","description":"Filter by groupId (IN)"},{"name":"roleIdIn","in":"query","schemaId":"schema_154","description":"Filter by roleId (IN)"},{"name":"startDateGte","in":"query","schemaId":"schema_155","description":"Filter by startDate (GTE)"},{"name":"startDateLte","in":"query","schemaId":"schema_155","description":"Filter by startDate (LTE)"},{"name":"endDateGte","in":"query","schemaId":"schema_155","description":"Filter by endDate (GTE)"},{"name":"endDateLte","in":"query","schemaId":"schema_155","description":"Filter by endDate (LTE)"}],"pointer":"/paths/~1hr~1v3~1role-assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hr/v3/role-assignments","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[{"name":"pageToken","in":"query","required":false,"example":"eyJpZCI6MTAwfQ","schemaId":"schema_143"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_144"},{"name":"idIn","in":"query","schemaId":"schema_151","style":"form","explode":true},{"name":"employeeIdIn","in":"query","schemaId":"schema_152","style":"form","explode":true},{"name":"groupIdIn","in":"query","schemaId":"schema_153","style":"form","explode":true},{"name":"roleIdIn","in":"query","schemaId":"schema_154","style":"form","explode":true},{"name":"startDateGte","in":"query","schemaId":"schema_155"},{"name":"startDateLte","in":"query","schemaId":"schema_155"},{"name":"endDateGte","in":"query","schemaId":"schema_155"},{"name":"endDateLte","in":"query","schemaId":"schema_155"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:role-assignments:read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/hr/v3/role-assignments","href":"role-assignment/listroleassignments","openApiOperationId":"listRoleAssignments","summary":"List role assignments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_CursorPageRoleAssignmentResponse"}},"schemaId":"components/schemas/security_CursorPageRoleAssignmentResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1role-assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security_CursorPageRoleAssignmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_CursorPageRoleAssignmentResponse"}}},{"code":"400","schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/role-assignments"},{"label":"Create a role assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role-assignment/createroleassignment","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role-assignment/createroleassignment","metadata":{"seo":{"title":"Create a role assignment","description":"Creates a new role assignment for an employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRoleAssignment","name":"Create a role assignment","isWebhook":false,"pointer":"/paths/~1hr~1v3~1role-assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a role assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new role assignment for an employee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:role-assignments:create"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentRequest"}},"schemaId":"components/schemas/security_RoleAssignmentRequest","pointer":"/paths/~1hr~1v3~1role-assignments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hr/v3/role-assignments","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:role-assignments:create"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentRequest"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/hr/v3/role-assignments","href":"role-assignment/createroleassignment","openApiOperationId":"createRoleAssignment","summary":"Create a role assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/security_RoleAssignmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentResponse"}},"schemaId":"components/schemas/security_RoleAssignmentResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1role-assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/security_RoleAssignmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentResponse"}}},{"code":"400","schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/role-assignments"},{"label":"Delete a role assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role-assignment/deleteroleassignment","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role-assignment/deleteroleassignment","metadata":{"seo":{"title":"Delete a role assignment","description":"Deletes a role assignment by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRoleAssignment","name":"Delete a role assignment","isWebhook":false,"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a role assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a role assignment by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:role-assignments:delete"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_155","required":true}],"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hr/v3/role-assignments/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_155"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:role-assignments:delete"]}],"responseCodes":["204","401","403","404","500"],"pointer":"/hr/v3/role-assignments/{id}","href":"role-assignment/deleteroleassignment","openApiOperationId":"deleteRoleAssignment","summary":"Delete a role assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/role-assignments/{id}"},{"label":"Update a role assignment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/role-assignment/updateroleassignment","routeSlug":"/api/v3/specs/quinyx-public-api-v3/role-assignment/updateroleassignment","metadata":{"seo":{"title":"Update a role assignment","description":"Updates the start date and/or end date of a role assignment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRoleAssignment","name":"Update a role assignment","isWebhook":false,"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a role assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the start date and/or end date of a role assignment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["hr:role-assignments:update"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_155","required":true}],"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentUpdateRequest"}},"schemaId":"components/schemas/security_RoleAssignmentUpdateRequest","pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/hr/v3/role-assignments/{id}","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_155"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["hr:role-assignments:update"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentUpdateRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/hr/v3/role-assignments/{id}","href":"role-assignment/updateroleassignment","openApiOperationId":"updateRoleAssignment","summary":"Update a role assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"schemaId":"components/schemas/security_RoleAssignmentUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentResponse"}},"schemaId":"components/schemas/security_RoleAssignmentResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1hr~1v3~1role-assignments~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security_RoleAssignmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security_RoleAssignmentResponse"}}},{"code":"400","schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_146","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"404","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/hr/v3/role-assignments/{id}"}],"content":{"contentType":"group","meta":{"name":"Role Assignment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role Assignment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hr/v3/role-assignments","summary":"List role assignments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/role-assignment/listroleassignments","deprecated":false},{"title":"/hr/v3/role-assignments","summary":"Create a role assignment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/role-assignment/createroleassignment","deprecated":false},{"title":"/hr/v3/role-assignments/{id}","summary":"Delete a role assignment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/role-assignment/deleteroleassignment","deprecated":false},{"title":"/hr/v3/role-assignments/{id}","summary":"Update a role assignment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/role-assignment/updateroleassignment","deprecated":false}]}]}]}]}},{"type":"separator","label":"Schedule","content":null},{"type":"group","label":"Shift","link":"/api/v3/specs/quinyx-public-api-v3/shift","routeSlug":"/api/v3/specs/quinyx-public-api-v3/shift","items":[{"label":"List shifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/v3/specs/quinyx-public-api-v3/shift/getshifts","routeSlug":"/api/v3/specs/quinyx-public-api-v3/shift/getshifts","metadata":{"seo":{"title":"List shifts","description":"Returns shifts using cursor-based pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShifts","name":"List shifts","isWebhook":false,"pointer":"/paths/~1schedule~1v3~1shifts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List shifts","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":"Returns shifts using cursor-based pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric internal IDs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External IDs using prefix 'xrefId:'"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employee badge numbers using prefix 'badgeNumber:'"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone override via Prefer header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is cursor-based. Use the returned pageToken for next/previous navigation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2ClientCredentials","scopes":["schedule:shifts:read"],"type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageToken","in":"query","schemaId":"schema_143","description":"Cursor for the next page of results."},{"name":"pageSize","in":"query","schemaId":"schema_144","description":"Maximum number of items to return."},{"name":"idIn","in":"query","schemaId":"schema_156","description":"Filter by id (IN). Supports external ids of types: xrefId"},{"name":"groupIdIn","in":"query","schemaId":"schema_157","description":"Filter by groupId (IN). Supports external ids of types: xrefId"},{"name":"employeeIdIn","in":"query","schemaId":"schema_158","description":"Filter by employeeId (IN). Supports external ids of types: badgeNumber"},{"name":"beginGte","in":"query","schemaId":"schema_159","description":"Filter by begin (GTE)"},{"name":"beginLte","in":"query","schemaId":"schema_159","description":"Filter by begin (LTE)"},{"name":"statusIn","in":"query","schemaId":"schema_160","description":"Filter by status (IN)"},{"name":"deleted","in":"query","schemaId":"schema_155","description":"Filter by deleted (EQ)"}],"pointer":"/paths/~1schedule~1v3~1shifts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_155","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional header for response formatting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefer: timezone=Europe/Belgrade"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects only response date-time values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does NOT affect filtering parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default response timezone is UTC."},"children":[]}]}]}],"example":"timezone=Europe/Belgrade"}],"pointer":"/paths/~1schedule~1v3~1shifts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/schedule/v3/shifts","servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}],"parameters":{"path":[],"query":[{"name":"pageToken","in":"query","required":false,"example":"eyJpZCI6MTAwfQ","schemaId":"schema_143"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_144"},{"name":"idIn","in":"query","schemaId":"schema_156","style":"form","explode":true},{"name":"groupIdIn","in":"query","schemaId":"schema_157","style":"form","explode":true},{"name":"employeeIdIn","in":"query","schemaId":"schema_158","style":"form","explode":true},{"name":"beginGte","in":"query","schemaId":"schema_159"},{"name":"beginLte","in":"query","schemaId":"schema_159"},{"name":"statusIn","in":"query","schemaId":"schema_160","style":"form","explode":true},{"name":"deleted","in":"query","schemaId":"schema_155"}],"querystring":[],"header":[{"name":"Prefer","in":"header","required":false,"example":"timezone=Europe/Belgrade","schemaId":"schema_155"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2ClientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}],"scopes":["schedule:shifts:read"]}],"responseCodes":["200","400","401","403","500"],"pointer":"/schedule/v3/shifts","href":"shift/getshifts","openApiOperationId":"getShifts","summary":"List shifts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu"}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/shifts_CursorPageShift"}},"schemaId":"components/schemas/shifts_CursorPageShift"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_161","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}},"schemaId":"schema_161","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden"]},{"code":"500","description":"Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError"]}},"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError"]}],"pointer":"/paths/~1schedule~1v3~1shifts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/shifts_CursorPageShift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/shifts_CursorPageShift"}}},{"code":"400","schemaId":"schema_161","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_161","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail","paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"]}}},{"code":"401","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden"]}}},{"code":"500","schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/employee_ProblemDetail","exampleIds":["paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError"]}}}],"examples":[]}]}]}]},"httpPath":"/schedule/v3/shifts"}],"content":{"contentType":"group","meta":{"name":"Shift"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shift","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/schedule/v3/shifts","summary":"List shifts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shift/getshifts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/employee_IntegrationEmployeeUpdateRequest":{"id":"components/schemas/employee_IntegrationEmployeeUpdateRequest","kind":"json-schema","title":"employee_IntegrationEmployeeUpdateRequest","data":{"type":"object","properties":{"badgeNumber":{"type":"string","description":"Unique badge number identifying the employee","example":"001","maxLength":20,"minLength":0},"email":{"type":"string","format":"email","description":"Employee email address","example":"employee@example.com","maxLength":255,"minLength":0},"personalInformation":{"$ref":"#/components/schemas/employee_UpdatePersonalInformation"},"contactInformation":{"$ref":"#/components/schemas/employee_UpdateContactInformation"},"address":{"$ref":"#/components/schemas/employee_UpdateAddress"},"employment":{"$ref":"#/components/schemas/employee_UpdateEmployment"},"emergencyContact":{"$ref":"#/components/schemas/employee_UpdateEmergencyContact"},"punchSettings":{"$ref":"#/components/schemas/employee_UpdatePunchSettings"}},"required":["address","badgeNumber","contactInformation","email","emergencyContact","employment","personalInformation","punchSettings"]}},"components/schemas/employee_UpdateAddress":{"id":"components/schemas/employee_UpdateAddress","kind":"json-schema","title":"employee_UpdateAddress","data":{"type":"object","properties":{"address1":{"type":"string","description":"Primary address line","example":"123 Example Street","maxLength":50,"minLength":0},"address2":{"type":"string","description":"Secondary address line","example":"Apt 1","maxLength":50,"minLength":0},"zip":{"type":"string","description":"Postal or ZIP code","example":"SE-10000","maxLength":20,"minLength":0},"city":{"type":"string","description":"City of residence","example":"Stockholm","maxLength":50,"minLength":0},"country":{"type":"string","description":"Country of residence","example":"Sweden","maxLength":50,"minLength":0}},"required":["address1","address2","city","country","zip"]}},"components/schemas/employee_UpdateContactInformation":{"id":"components/schemas/employee_UpdateContactInformation","kind":"json-schema","title":"employee_UpdateContactInformation","data":{"type":"object","properties":{"mobileNumber":{"type":"string","description":"Employee's mobile phone number","example":"+46700000000","maxLength":20,"minLength":0},"phoneNumber":{"type":"string","description":"Employee's work phone number","example":"+46800000000","maxLength":20,"minLength":0}},"required":["mobileNumber","phoneNumber"]}},"components/schemas/employee_UpdateEmergencyContact":{"id":"components/schemas/employee_UpdateEmergencyContact","kind":"json-schema","title":"employee_UpdateEmergencyContact","data":{"type":"object","properties":{"nextOfKinName":{"type":"string","description":"Name of the employee's next of kin","example":"John Doe","maxLength":50,"minLength":0},"nextOfKinPhone":{"type":"string","description":"Phone number of the employee's next of kin","example":"+46700000000","maxLength":20,"minLength":0},"legalGuardianName":{"type":"string","description":"Name of the employee's legal guardian","example":"Jane Doe","maxLength":50,"minLength":0},"legalGuardianEmail":{"type":"string","description":"Email address of the employee's legal guardian","example":"guardian@example.com","maxLength":50,"minLength":0}},"required":["legalGuardianEmail","legalGuardianName","nextOfKinName","nextOfKinPhone"]}},"components/schemas/employee_UpdateEmployment":{"id":"components/schemas/employee_UpdateEmployment","kind":"json-schema","title":"employee_UpdateEmployment","data":{"type":"object","properties":{"homeGroupId":{"type":"string","description":"ID of the employee's home group","example":"123","minLength":1},"staffCategoryId":{"type":"string","description":"ID of the staff category assigned to the employee","example":"123"},"managerId":{"type":"string","description":"ID of the employee's manager","example":"1234"},"passive":{"type":"boolean","description":"Whether the employee is passive","example":false},"locked":{"type":"string","description":"Lock status of the employee account","enum":["NOT_LOCKED","LOCKED_BY_MANAGER","LOCKED_BY_SYSTEM"],"example":"NOT_LOCKED"},"employmentStartDate":{"type":"string","format":"date","description":"Date when the employment started","example":"2020-01-01"},"employmentEndDate":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the employment ends, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if employed indefinitely"},"children":[]}]}]}],"example":"2025-12-31"},"industryStartDate":{"type":"string","format":"date","description":"Date when the employee started working in the industry","example":"2015-01-01"},"costCentreId":{"type":"string","description":"Cost centre ID","example":"1234"}},"required":["employmentStartDate","homeGroupId","industryStartDate","locked","passive","staffCategoryId"]}},"components/schemas/employee_UpdatePersonalInformation":{"id":"components/schemas/employee_UpdatePersonalInformation","kind":"json-schema","title":"employee_UpdatePersonalInformation","data":{"type":"object","properties":{"firstName":{"type":"string","description":"Employee's first name","example":"John","maxLength":40,"minLength":0},"lastName":{"type":"string","description":"Employee's last name","example":"Doe","maxLength":40,"minLength":0},"dateOfBirth":{"type":"string","format":"date","description":"Employee's date of birth ","example":"1990-01-01"},"gender":{"type":"string","description":"Employee's gender","enum":["MALE","FEMALE","OTHER","NOT_SPECIFIED"],"example":"MALE"},"socialSecurityNumber":{"type":"string","description":"Employee's social security number ","example":"000000-0000"},"pictureURL":{"type":"string","description":"URL to the employee's profile picture","example":"https://example.com/pictures/placeholder.jpg"}},"required":["dateOfBirth","firstName","gender","lastName","pictureURL","socialSecurityNumber"]}},"components/schemas/employee_UpdatePunchSettings":{"id":"components/schemas/employee_UpdatePunchSettings","kind":"json-schema","title":"employee_UpdatePunchSettings","data":{"type":"object","properties":{"allowAttestOfOwnPunches":{"type":"boolean","description":"Whether the employee is allowed to attest their own time punches","example":false}},"required":["allowAttestOfOwnPunches"]}},"components/schemas/employee_ProblemDetail":{"id":"components/schemas/employee_ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","description":"RFC 9457 Problem Details for HTTP APIs","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/error-type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Error Title"},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":404},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","example":"A detailed explanation of the error"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/api/endpoint"}},"required":["status","title","type"],"title":"ProblemDetail"}},"components/schemas/employee_ValidationError":{"id":"components/schemas/employee_ValidationError","kind":"json-schema","title":"ValidationError","data":{"type":"object","description":"Validation errors, conforming to RFC 9457.","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/validation-error"},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","example":"The request is not valid."},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":422},"errors":{"type":"array","description":"A list of validation errors.","items":{"$ref":"#/components/schemas/employee_ValidationErrorDetail"},"maxItems":50,"minItems":1},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/endpoint"}},"required":["errors","status","title","type"],"title":"ValidationError"}},"components/schemas/employee_ValidationErrorDetail":{"id":"components/schemas/employee_ValidationErrorDetail","kind":"json-schema","title":"employee_ValidationErrorDetail","data":{"type":"object","description":"A single validation error.","properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"name is mandatory"},"pointer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON Pointer [RFC6901] to the associated entity in the request body."},"children":[]}]}]}],"example":"#/name"}}}},"components/schemas/employee_Address":{"id":"components/schemas/employee_Address","kind":"json-schema","title":"employee_Address","data":{"type":"object","properties":{"address1":{"type":"string","description":"Primary address line","example":"123 Example Street","maxLength":50,"minLength":0},"address2":{"type":"string","description":"Secondary address line","example":"Apt 1","maxLength":50,"minLength":0},"zip":{"type":"string","description":"Postal or ZIP code","example":"SE-10000","maxLength":20,"minLength":0},"city":{"type":"string","description":"City of residence","example":"Stockholm","maxLength":50,"minLength":0},"country":{"type":"string","description":"Country of residence","example":"Sweden","maxLength":50,"minLength":0}}}},"components/schemas/employee_ContactInformation":{"id":"components/schemas/employee_ContactInformation","kind":"json-schema","title":"employee_ContactInformation","data":{"type":"object","properties":{"mobileNumber":{"type":"string","description":"Employee's mobile phone number","example":"+46700000000","maxLength":20,"minLength":0},"phoneNumber":{"type":"string","description":"Employee's work phone number","example":"+46800000000","maxLength":20,"minLength":0}}}},"components/schemas/employee_EmergencyContact":{"id":"components/schemas/employee_EmergencyContact","kind":"json-schema","title":"employee_EmergencyContact","data":{"type":"object","properties":{"nextOfKinName":{"type":"string","description":"Name of the employee's next of kin","example":"John Doe","maxLength":50,"minLength":0},"nextOfKinPhone":{"type":"string","description":"Phone number of the employee's next of kin","example":"+46700000000","maxLength":20,"minLength":0},"legalGuardianName":{"type":"string","description":"Name of the employee's legal guardian","example":"Jane Doe","maxLength":50,"minLength":0},"legalGuardianEmail":{"type":"string","description":"Email address of the employee's legal guardian","example":"guardian@example.com","maxLength":50,"minLength":0}}}},"components/schemas/employee_Employment":{"id":"components/schemas/employee_Employment","kind":"json-schema","title":"employee_Employment","data":{"type":"object","properties":{"homeGroupId":{"type":"string","description":"ID of the employee's home group","example":"123"},"staffCategoryId":{"type":"string","description":"ID of the staff category assigned to the employee","example":"123"},"passive":{"type":"boolean","description":"Whether the employee is passive","example":false},"locked":{"type":"string","description":"Lock status of the employee account","enum":["NOT_LOCKED","LOCKED_BY_MANAGER","LOCKED_BY_SYSTEM"],"example":"NOT_LOCKED"},"employmentStartDate":{"type":"string","format":"date","description":"Date when the employment started","example":"2020-01-01"},"industryStartDate":{"type":"string","format":"date","description":"Date when the employee started working in the industry","example":"2015-01-01"},"managerId":{"type":"string","description":"ID of the employee's manager","example":"1234"},"employmentEndDate":{"type":"string","format":"date","description":"Date when the employment ends, if applicable","example":"2025-12-31"},"costCentreId":{"type":"string","description":"Cost centre ID","example":"1234"}}}},"components/schemas/employee_IntegrationEmployeeResponse":{"id":"components/schemas/employee_IntegrationEmployeeResponse","kind":"json-schema","title":"employee_IntegrationEmployeeResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal employee ID, assigned by the system","example":"12345","readOnly":true},"badgeNumber":{"type":"string","description":"Unique badge number identifying the employee","example":"001","maxLength":20,"minLength":0},"email":{"type":"string","format":"email","description":"Employee email address","example":"employee@example.com","maxLength":255,"minLength":0},"personalInformation":{"$ref":"#/components/schemas/employee_PersonalInformation"},"contactInformation":{"$ref":"#/components/schemas/employee_ContactInformation"},"address":{"$ref":"#/components/schemas/employee_Address"},"employment":{"$ref":"#/components/schemas/employee_Employment"},"emergencyContact":{"$ref":"#/components/schemas/employee_EmergencyContact"},"punchSettings":{"$ref":"#/components/schemas/employee_PunchSettings"},"updated":{"type":"string","format":"date-time","description":"Timestamp of the last update to the employee record","example":"2024-06-01T10:00:00Z","readOnly":true},"created":{"type":"string","format":"date-time","description":"Timestamp when the employee record was created","example":"2024-06-01T10:00:00Z","readOnly":true}}}},"components/schemas/employee_PersonalInformation":{"id":"components/schemas/employee_PersonalInformation","kind":"json-schema","title":"employee_PersonalInformation","data":{"type":"object","properties":{"firstName":{"type":"string","description":"Employee's first name","example":"John","maxLength":40,"minLength":0},"lastName":{"type":"string","description":"Employee's last name","example":"Doe","maxLength":40,"minLength":0},"dateOfBirth":{"type":"string","format":"date","description":"Employee's date of birth","example":"1990-01-01"},"gender":{"type":"string","description":"Employee's gender","enum":["MALE","FEMALE","OTHER","NOT_SPECIFIED"],"example":"MALE"},"socialSecurityNumber":{"type":"string","description":"Employee's social security number","example":"000000-0000"},"pictureURL":{"type":"string","description":"URL to the employee's profile picture","example":"https://example.com/pictures/placeholder.jpg"}}}},"components/schemas/employee_PunchSettings":{"id":"components/schemas/employee_PunchSettings","kind":"json-schema","title":"employee_PunchSettings","data":{"type":"object","properties":{"allowAttestOfOwnPunches":{"type":"boolean","description":"Whether the employee is allowed to attest their own time punches","example":false}}}},"components/schemas/employee_CreateEmployment":{"id":"components/schemas/employee_CreateEmployment","kind":"json-schema","title":"employee_CreateEmployment","data":{"type":"object","properties":{"homeGroupId":{"type":"string","description":"ID of the employee's home group","example":"123","minLength":1},"staffCategoryId":{"type":"string","description":"ID of the staff category assigned to the employee","example":"123"},"managerId":{"type":"string","description":"ID of the employee's manager","example":"1234"},"passive":{"type":"boolean","description":"Whether the employee is passive","example":false},"locked":{"type":"string","description":"Lock status of the employee account","enum":["NOT_LOCKED","LOCKED_BY_MANAGER","LOCKED_BY_SYSTEM"],"example":"NOT_LOCKED"},"employmentStartDate":{"type":"string","format":"date","description":"Date when the employment started","example":"2020-01-01"},"employmentEndDate":{"type":"string","format":"date","description":"Date when the employment ends, if applicable","example":"2025-12-31"},"industryStartDate":{"type":"string","format":"date","description":"Date when the employee started working in the industry","example":"2015-01-01"},"costCentreId":{"type":"string","description":"Cost centre ID","example":"1234"}},"required":["employmentStartDate","homeGroupId"]}},"components/schemas/employee_CreatePersonalInformation":{"id":"components/schemas/employee_CreatePersonalInformation","kind":"json-schema","title":"employee_CreatePersonalInformation","data":{"type":"object","properties":{"firstName":{"type":"string","description":"Employee's first name","example":"John","maxLength":40,"minLength":0},"lastName":{"type":"string","description":"Employee's last name","example":"Doe","maxLength":40,"minLength":0},"dateOfBirth":{"type":"string","format":"date","description":"Employee's date of birth","example":"1990-01-01"},"gender":{"type":"string","description":"Employee's gender","enum":["MALE","FEMALE","OTHER","NOT_SPECIFIED"],"example":"MALE"},"socialSecurityNumber":{"type":"string","description":"Employee's social security number","example":"000000-0000"},"pictureURL":{"type":"string","description":"URL to the employee's profile picture","example":"https://example.com/pictures/placeholder.jpg"}},"required":["firstName","lastName"]}},"components/schemas/employee_IntegrationEmployeeCreateRequest":{"id":"components/schemas/employee_IntegrationEmployeeCreateRequest","kind":"json-schema","title":"employee_IntegrationEmployeeCreateRequest","data":{"type":"object","properties":{"badgeNumber":{"type":"string","description":"Unique badge number identifying the employee","example":"001","maxLength":20,"minLength":0},"email":{"type":"string","format":"email","description":"Employee email address","example":"employee@example.com","maxLength":255,"minLength":0},"personalInformation":{"$ref":"#/components/schemas/employee_CreatePersonalInformation"},"contactInformation":{"$ref":"#/components/schemas/employee_ContactInformation"},"address":{"$ref":"#/components/schemas/employee_Address"},"employment":{"$ref":"#/components/schemas/employee_CreateEmployment"},"emergencyContact":{"$ref":"#/components/schemas/employee_EmergencyContact"},"punchSettings":{"$ref":"#/components/schemas/employee_PunchSettings"}},"required":["badgeNumber","email","employment","personalInformation"]}},"components/schemas/employee_IntegrationEmployeePatchRequest":{"id":"components/schemas/employee_IntegrationEmployeePatchRequest","kind":"json-schema","title":"employee_IntegrationEmployeePatchRequest","data":{"type":"object","properties":{"badgeNumber":{"type":"string","description":"Unique badge number identifying the employee","example":"001","maxLength":20,"minLength":0},"email":{"type":"string","format":"email","description":"Employee email address","example":"employee@example.com","maxLength":255,"minLength":0},"personalInformation":{"$ref":"#/components/schemas/employee_PersonalInformation"},"contactInformation":{"$ref":"#/components/schemas/employee_ContactInformation"},"address":{"$ref":"#/components/schemas/employee_Address"},"employment":{"$ref":"#/components/schemas/employee_Employment"},"emergencyContact":{"$ref":"#/components/schemas/employee_EmergencyContact"},"punchSettings":{"$ref":"#/components/schemas/employee_PunchSettings"}}}},"components/schemas/employee_CursorPageIntegrationEmployeeResponse":{"id":"components/schemas/employee_CursorPageIntegrationEmployeeResponse","kind":"json-schema","title":"employee_CursorPageIntegrationEmployeeResponse","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/employee_IntegrationEmployeeResponse"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/employee_CursorPaginationInfo"}}}},"components/schemas/employee_CursorPaginationInfo":{"id":"components/schemas/employee_CursorPaginationInfo","kind":"json-schema","title":"employee_CursorPaginationInfo","data":{"type":"object","description":"Pagination information for cursor-based pagination.","properties":{"nextPageToken":{"type":"string","description":"The token for the next page","example":"eyJpZCI6MTIwfQ"},"previousPageToken":{"type":"string","description":"The token for the previous page","example":"eyJpZCI6ODB9"}}}},"components/schemas/employee_AdditionalFieldsSection":{"id":"components/schemas/employee_AdditionalFieldsSection","kind":"json-schema","title":"employee_AdditionalFieldsSection","data":{"type":"object","properties":{"additionalField1":{"type":"string","description":"Additional field 1","example":"Cost centre 4711"},"additionalField2":{"type":"string","description":"Additional field 2","example":"Contract reference 88123"},"additionalField3":{"type":"string","description":"Additional field 3","example":"Union agreement 2025"},"additionalField4":{"type":"string","description":"Additional field 4","example":"Region North"},"additionalField5":{"type":"string","description":"Additional field 5","example":"Reviewed by payroll"}}}},"components/schemas/employee_AdvancedCalculationSection":{"id":"components/schemas/employee_AdvancedCalculationSection","kind":"json-schema","title":"employee_AdvancedCalculationSection","data":{"type":"object","properties":{"calculateEmploymentRateType":{"type":"string","description":"Advanced calculation mode for part-time employees","enum":["NO_CALCULATION","USED_FOR_ABSENCE_QUALIFYING_PERIOD","USED_FOR_ABSENCE_SCHEDULE"],"example":"NO_CALCULATION"},"weeksBackInTimeForEmploymentRateCalculation":{"type":"integer","format":"int32","description":"Weeks back in time used for the calculation","example":0}}}},"components/schemas/employee_AgeBasedSalaryAdditionRow":{"id":"components/schemas/employee_AgeBasedSalaryAdditionRow","kind":"json-schema","title":"employee_AgeBasedSalaryAdditionRow","data":{"type":"object","properties":{"startAge":{"type":"string","description":"Employee age","example":"40.0"},"value":{"type":"string","description":"Salary adjustment","example":"60.0"}}}},"components/schemas/employee_AgreementDetailsSection":{"id":"components/schemas/employee_AgreementDetailsSection","kind":"json-schema","title":"employee_AgreementDetailsSection","data":{"type":"object","properties":{"templateId":{"type":"string","description":"Internal ID of the agreement template","example":"19964"},"groupId":{"type":"string","description":"Internal ID of the UNIT group the agreement is assigned to","example":"115041"},"name":{"type":"string","description":"Name of the agreement","example":"John Smith Monthly Agreement"},"startDate":{"type":"string","format":"date","description":"Start of the agreement","example":"2018-03-09"},"endDate":{"type":"string","format":"date","description":"End of the agreement. Returned as null while the agreement does not expire.","example":"2029-03-31"},"comment":{"type":"string","description":"Free-text comment on the agreement","example":"Temporary summer contract"},"payScheduleId":{"type":"string","description":"Internal ID of the pay schedule","example":"9"}}}},"components/schemas/employee_AvailabilityRow":{"id":"components/schemas/employee_AvailabilityRow","kind":"json-schema","title":"employee_AvailabilityRow","data":{"type":"object","properties":{"weekNumber":{"type":"string","description":"Week number","example":"1"},"weekDay":{"type":"string","description":"Day of the week the availability applies to","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"SUNDAY"},"startTime":{"type":"string","description":"Available from","example":"00:00:00"},"endTime":{"type":"string","description":"Available to","example":"00:00:00"}}}},"components/schemas/employee_AvailabilitySection":{"id":"components/schemas/employee_AvailabilitySection","kind":"json-schema","title":"employee_AvailabilitySection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"checkAvailability":{"type":"boolean","description":"Check availability","example":true},"weeksAvailable":{"type":"string","description":"Number of weeks in the availability cycle","example":"1"},"availabilities":{"type":"array","description":"Availability rows for this agreement, ordered by week, then by day of the week from Monday, then by the time availability opens. At most 200 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_AvailabilityRow"},"maxItems":200}}}},"components/schemas/employee_BalancePeriodSection":{"id":"components/schemas/employee_BalancePeriodSection","kind":"json-schema","title":"employee_BalancePeriodSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the balance period values are inherited from the template","example":true},"period":{"type":"string","description":"Balance period unit","enum":["MONTHS","DAYS"],"example":"MONTHS"},"length":{"type":"string","description":"Number of months or days in the balance period","example":"1"},"hours":{"type":"string","description":"Hours in the balance period","example":"184.0"},"startDate":{"type":"string","format":"date","description":"Start of the balance period","example":"2018-03-09"}}}},"components/schemas/employee_BreakCalculationRulesSection":{"id":"components/schemas/employee_BreakCalculationRulesSection","kind":"json-schema","title":"employee_BreakCalculationRulesSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"useStandardBreakCreationRules":{"type":"boolean","description":"Use rules defined on the unit the agreement belongs to. Only applied when template rules are off.","example":false},"projectBreaks":{"type":"array","description":"Project break rules for this agreement, grouped by the weekday they apply to and then ordered by shift length. Rules that apply to every day come first. At most 100 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_ProjectBreakRow"},"maxItems":100}}}},"components/schemas/employee_BreakRulesAndScheduleChangesSection":{"id":"components/schemas/employee_BreakRulesAndScheduleChangesSection","kind":"json-schema","title":"employee_BreakRulesAndScheduleChangesSection","data":{"type":"object","properties":{"breakIsWorkTime":{"type":"boolean","description":"Calculate breaks as working time","example":true},"maxTimeWithoutBreak":{"type":"string","description":"Maximum work hours without breaks","example":"5.76"},"minBreakInMinutes":{"type":"string","description":"Minimum break in minutes","example":"15"},"maxBreakInMinutes":{"type":"string","description":"Maximum break in minutes","example":"45"},"scheduleChanges":{"$ref":"#/components/schemas/employee_ScheduleChangesSection"}}}},"components/schemas/employee_CursorPageIntegrationAgreementResponse":{"id":"components/schemas/employee_CursorPageIntegrationAgreementResponse","kind":"json-schema","title":"employee_CursorPageIntegrationAgreementResponse","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/employee_IntegrationAgreementResponse"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/employee_CursorPaginationInfo"}}}},"components/schemas/employee_DailyWorkingHoursRow":{"id":"components/schemas/employee_DailyWorkingHoursRow","kind":"json-schema","title":"employee_DailyWorkingHoursRow","data":{"type":"object","properties":{"day":{"type":"string","description":"Day of the week the hours apply to","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"MONDAY"},"hours":{"type":"string","description":"Working hours for the day","example":"7.5"}}}},"components/schemas/employee_EmployeeAgeSection":{"id":"components/schemas/employee_EmployeeAgeSection","kind":"json-schema","title":"employee_EmployeeAgeSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"ageBasedSalaryAdditionCalculationMode":{"type":"string","description":"Starting point for calculation","enum":["SAME_CALENDAR_MONTH","EXACT_CALENDAR_DAY","NEXT_CALENDAR_MONTH"],"example":"SAME_CALENDAR_MONTH"},"ageBasedSalaryAdditionSettings":{"type":"array","description":"Age-based salary addition settings for this agreement, lowest start age first. At most 50 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_AgeBasedSalaryAdditionRow"},"maxItems":50}}}},"components/schemas/employee_EmploymentRateRow":{"id":"components/schemas/employee_EmploymentRateRow","kind":"json-schema","title":"employee_EmploymentRateRow","data":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"Start of the employment rate period. Omitted for the initial period.","example":"2025-02-01"},"value":{"type":"string","description":"Employment rate percentage","example":"80.0"}}}},"components/schemas/employee_EmploymentRateSection":{"id":"components/schemas/employee_EmploymentRateSection","kind":"json-schema","title":"employee_EmploymentRateSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the employment rate values are inherited from the template","example":true},"rates":{"type":"array","description":"Employment rate rows for this agreement, oldest first. The row that has no start date applies from the beginning of time and is returned first. At most 200 are returned; when an agreement holds more, the earliest 200 are returned and the most recent are omitted.","items":{"$ref":"#/components/schemas/employee_EmploymentRateRow"},"maxItems":200}}}},"components/schemas/employee_EmploymentTenureSalaryAdditionRow":{"id":"components/schemas/employee_EmploymentTenureSalaryAdditionRow","kind":"json-schema","title":"employee_EmploymentTenureSalaryAdditionRow","data":{"type":"object","properties":{"yearsWorked":{"type":"string","description":"Years worked","example":"0.0"},"salaryAdjustment":{"type":"string","description":"Salary adjustment","example":"55.0"}}}},"components/schemas/employee_EsignElementRow":{"id":"components/schemas/employee_EsignElementRow","kind":"json-schema","title":"employee_EsignElementRow","data":{"type":"object","properties":{"position":{"type":"string","description":"Position of the signee","enum":["SELF","LOGGED_IN_MANAGER","LEGAL_GUARDIAN","UNIT_MANAGER","SPECIFIED_EMAIL","DISTRICT_MANAGER","SPECIFIED_EMPLOYEE"],"example":"SPECIFIED_EMPLOYEE"},"contactDetails":{"type":"string","description":"Contact details of the signee","example":"822912"},"signatory":{"type":"boolean","description":"Whether this element signs the contract","example":false}}}},"components/schemas/employee_EsignSection":{"id":"components/schemas/employee_EsignSection","kind":"json-schema","title":"employee_EsignSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"eSignElements":{"type":"array","description":"E-sign elements for this agreement, in the order the signing flow runs. At most 20 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_EsignElementRow"},"maxItems":20},"assertSigned":{"type":"boolean","description":"Assert that the contract is already valid","example":false}}}},"components/schemas/employee_IntegrationAgreementResponse":{"id":"components/schemas/employee_IntegrationAgreementResponse","kind":"json-schema","title":"employee_IntegrationAgreementResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Internal agreement ID, assigned by the system","example":"154678","readOnly":true},"xrefId":{"type":"string","description":"External agreement ID, set by the client","example":"agreement-external-id-7"},"employeeId":{"type":"string","description":"Internal ID of the employee the agreement belongs to","example":"822912","readOnly":true},"mainAgreement":{"type":"boolean","description":"Whether this is the employee's main agreement","example":true},"details":{"$ref":"#/components/schemas/employee_AgreementDetailsSection"},"salary":{"$ref":"#/components/schemas/employee_SalarySection"},"employmentRate":{"$ref":"#/components/schemas/employee_EmploymentRateSection"},"balancePeriod":{"$ref":"#/components/schemas/employee_BalancePeriodSection"},"schedulePeriod":{"$ref":"#/components/schemas/employee_SchedulePeriodSection"},"workingTimeAndScheduleChanges":{"$ref":"#/components/schemas/employee_WorkingTimeAndScheduleChangesSection"},"breakCalculationRules":{"$ref":"#/components/schemas/employee_BreakCalculationRulesSection"},"salaryAdjustments":{"$ref":"#/components/schemas/employee_SalaryAdjustmentsSection"},"socialCosts":{"$ref":"#/components/schemas/employee_SocialCostsSection"},"additionalFields":{"$ref":"#/components/schemas/employee_AdditionalFieldsSection"},"monthlyNominalHoursPerYear":{"$ref":"#/components/schemas/employee_MonthlyNominalHoursPerYearSection"},"time":{"$ref":"#/components/schemas/employee_TimeSection"},"availability":{"$ref":"#/components/schemas/employee_AvailabilitySection"},"esign":{"$ref":"#/components/schemas/employee_EsignSection"},"mobilePunchFlow":{"$ref":"#/components/schemas/employee_MobilePunchFlowSection"},"created":{"type":"string","format":"date-time","description":"Timestamp when the agreement was created. Omitted for agreements created before this field was introduced.","example":"2025-09-25T11:52:00Z","readOnly":true},"updated":{"type":"string","format":"date-time","description":"Timestamp of the last update to the agreement","example":"2025-09-25T11:52:00Z","readOnly":true}}}},"components/schemas/employee_MobilePunchFlowSection":{"id":"components/schemas/employee_MobilePunchFlowSection","kind":"json-schema","title":"employee_MobilePunchFlowSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"allowPunchingOnPastTasks":{"type":"boolean","description":"Allow punching on past tasks","example":false},"splitPunchOnTasks":{"type":"boolean","description":"Split punch on tasks","example":true},"chooseProjectOnPunch":{"type":"boolean","description":"Allow choice of project","example":false},"chooseCostCentreOnPunch":{"type":"boolean","description":"Allow choice of cost centre","example":false},"showOvertimePopUpOnPunch":{"type":"boolean","description":"Show overtime pop-up","example":false},"canChooseOvertimeTypeOnPunch":{"type":"boolean","description":"Choose overtime type","example":false},"showCommentOnPunch":{"type":"boolean","description":"Show comment for punch","example":false},"showNoShiftPopUpOnPunch":{"type":"boolean","description":"Show 'No shift' pop-up","example":false},"showAbsenceTypePopUpOnPunch":{"type":"boolean","description":"Show absence type pop-up","example":false},"canIgnoreAbsenceTypeOnPunch":{"type":"boolean","description":"Allow to ignore absence type","example":false},"showAbsenceTypeCommentOnPunch":{"type":"boolean","description":"Show absence type comment","example":false},"absenceTypeCommentIsMandatoryOnPunch":{"type":"boolean","description":"Absence type comment is mandatory","example":false}}}},"components/schemas/employee_MonthlyHoursRow":{"id":"components/schemas/employee_MonthlyHoursRow","kind":"json-schema","title":"employee_MonthlyHoursRow","data":{"type":"object","properties":{"year":{"type":"string","description":"Year","example":"2025"},"month":{"type":"string","description":"Month","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"],"example":"JANUARY"},"hours":{"type":"string","description":"Nominal hours for the month","example":"176.0"}}}},"components/schemas/employee_MonthlyNominalHoursPerYearSection":{"id":"components/schemas/employee_MonthlyNominalHoursPerYearSection","kind":"json-schema","title":"employee_MonthlyNominalHoursPerYearSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"monthlyHours":{"type":"array","description":"Monthly nominal hours rows for this agreement, in chronological order. At most 200 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_MonthlyHoursRow"},"maxItems":200}}}},"components/schemas/employee_NominalDaysPerWeekRow":{"id":"components/schemas/employee_NominalDaysPerWeekRow","kind":"json-schema","title":"employee_NominalDaysPerWeekRow","data":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"Start of the period. Omitted for the initial period.","example":"2024-01-01"},"value":{"type":"string","description":"Nominal days per week (0 through 7)","example":"7"}}}},"components/schemas/employee_OvertimeAndUnsocialTimeSection":{"id":"components/schemas/employee_OvertimeAndUnsocialTimeSection","kind":"json-schema","title":"employee_OvertimeAndUnsocialTimeSection","data":{"type":"object","properties":{"timeBank":{"type":"string","description":"Flex time or time bank","enum":["FLEX_TIME","TIME_BANK"],"example":"FLEX_TIME"},"payOvertime":{"type":"string","description":"How overtime is compensated","enum":["PAID","SAVED_TIME_OFF_IN_LIEU"],"example":"PAID"},"allowIgnoringOvertimeInWebpunch":{"type":"boolean","description":"Allow user to ignore overtime in webpunch","example":false},"overtimes":{"type":"array","description":"Overtime types that apply to this agreement, in the order they are configured. At most 100 are returned; any beyond that are omitted from the response.","items":{"type":"string"},"maxItems":100},"payUnsocialTime":{"type":"string","description":"How unsocial time is compensated","enum":["PAID","SAVED_TIME_OFF_IN_LIEU"],"example":"PAID"},"lateChange":{"type":"boolean","description":"Late schedule change","example":false},"lateChangeUnsocialTime":{"type":"string","description":"Type of unsocial time for late schedule changes","enum":["UT_1","UT_2","UT_3","UT_4","UT_5","UT_6","UT_7","UT_8"],"example":"UT_1"}}}},"components/schemas/employee_PersonalSalaryAdditionRow":{"id":"components/schemas/employee_PersonalSalaryAdditionRow","kind":"json-schema","title":"employee_PersonalSalaryAdditionRow","data":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"Start of the addition. Omitted for the initial period.","example":"2026-03-01"},"salaryAdjustment":{"type":"string","description":"Salary adjustment","example":"0.0"}}}},"components/schemas/employee_ProjectBreakRow":{"id":"components/schemas/employee_ProjectBreakRow","kind":"json-schema","title":"employee_ProjectBreakRow","data":{"type":"object","properties":{"hours":{"type":"string","description":"Shift or punch length","example":"08:00:00"},"breakMinutes":{"type":"string","description":"Break in minutes","example":"30"},"weekday":{"type":"string","description":"Weekday the break applies to","enum":["ALL_DAYS","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"ALL_DAYS"},"showBreaks":{"type":"boolean","description":"Show breaks","example":false},"distribute":{"type":"string","description":"Location of breaks","enum":["BEGINNING","MIDDLE","END","AFTER"],"example":"BEGINNING"},"afterHours":{"type":"string","description":"Hours after which the break applies","example":"00:00:00"},"numberOfBreaks":{"type":"integer","format":"int32","description":"Number of breaks","example":1}}}},"components/schemas/employee_PunchAndWebpunchDeviationsSection":{"id":"components/schemas/employee_PunchAndWebpunchDeviationsSection","kind":"json-schema","title":"employee_PunchAndWebpunchDeviationsSection","data":{"type":"object","properties":{"breakRounding":{"type":"boolean","description":"Round breaks","example":false},"punchDeviations":{"type":"array","description":"Punch deviation rules for this agreement, ordered by rule type and, within a type, the rule on the punch in before the rule on the punch out. At most 50 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_PunchDeviationRow"},"maxItems":50},"webpunchCreateApprovedLeave":{"type":"boolean","description":"Create an approved absence","example":true}}}},"components/schemas/employee_PunchDeviationRow":{"id":"components/schemas/employee_PunchDeviationRow","kind":"json-schema","title":"employee_PunchDeviationRow","data":{"type":"object","properties":{"type":{"type":"string","description":"Deviation type","enum":["MAX_DIFFERENCE","ROUND_TO_SHIFT_START_END","ROUND_TO_TIME_INTERVAL","INDICATOR"],"example":"MAX_DIFFERENCE"},"minutes":{"type":"string","description":"Minutes","example":"15.0"},"punchPart":{"type":"string","description":"Punch the deviation applies to","enum":["IN","OUT"],"example":"IN"},"roundingRule":{"type":"string","description":"Rounding method","enum":["UP","DOWN","NEAREST"],"example":"UP"},"insideShift":{"type":"string","description":"Shift relation","enum":["BEFORE_SHIFT_STARTS","AFTER_SHIFT_STARTS","BOTH_BEFORE_AND_AFTER_SHIFT_STARTS"],"example":"BEFORE_SHIFT_STARTS"}}}},"components/schemas/employee_RulesForTimePunchingSection":{"id":"components/schemas/employee_RulesForTimePunchingSection","kind":"json-schema","title":"employee_RulesForTimePunchingSection","data":{"type":"object","properties":{"punchType":{"type":"string","description":"Type of time reporting","enum":["PUNCH_IN_OUT_AND_BREAKS","PUNCH_IN_OUT_BUT_NO_BREAKS","DEVIATION_REPORTING","PUNCH_WITHOUT_SCHEDULE"],"example":"PUNCH_IN_OUT_BUT_NO_BREAKS"},"autoAttestForAbsence":{"type":"boolean","description":"Auto attest for absence","example":true},"autoPunchOut":{"type":"string","description":"Automatic punch out after this many hours","example":"12.0"},"dayBreak":{"type":"string","description":"Daybreak","example":"00:00:00"},"ignoreLeaveReasonOnWebpunch":{"type":"boolean","description":"Ignore absence type in webpunch","example":false},"allowPunchingOnTasks":{"type":"boolean","description":"Allow punching on tasks","example":true},"splitPunchOnTaskForExistingShifts":{"type":"boolean","description":"Split shift's existing punch upon task addition","example":true},"generateSalariesOnTask":{"type":"boolean","description":"Generate salaries on task","example":true},"payrollFileId":{"type":"string","description":"Payroll file","example":"357"}}}},"components/schemas/employee_RulesForWorkingTimeSection":{"id":"components/schemas/employee_RulesForWorkingTimeSection","kind":"json-schema","title":"employee_RulesForWorkingTimeSection","data":{"type":"object","properties":{"useStandardHoursRules":{"type":"boolean","description":"Use default time rule","example":false},"maxHoursPerDay":{"type":"string","description":"Max hours per day","example":"12.32"},"maxHoursPerWeek":{"type":"string","description":"Max hours per week","example":"52.42"},"minRestPerDay":{"type":"string","description":"Minimum rest per day","example":"12"},"restMustBeAtDayBreak":{"type":"boolean","description":"Rest must be in connection with the daybreak","example":true},"minHoursPerWeek":{"type":"string","description":"Minimum hours per week","example":"15.0"},"minFreeDays":{"type":"string","description":"Free days","example":"2"},"maxDays":{"type":"string","description":"Max days","example":"8"},"minRestPerWeek":{"type":"string","description":"Minimum rest per week","example":"32.0"},"minFreeWeekendsPerYear":{"type":"integer","format":"int32","description":"Minimum free weekends per year","example":4},"checkMinimumRestPerWeek":{"type":"string","description":"How minimum rest per week is checked","enum":["FIXED_WEEK","ROLLING_FROM_LAST_REST_TIME"],"example":"ROLLING_FROM_LAST_REST_TIME"},"scheduleBankHolidays":{"type":"boolean","description":"Schedule bank holidays","example":true},"dayBreakRest":{"type":"string","description":"Agreement daybreak","example":"01:00:00"},"advancedTimeRules":{"type":"boolean","description":"Advanced time rules","example":false},"overtimeOverridesUnsocialTime":{"type":"boolean","description":"Overtime overrides unsocial time","example":false},"allowOverrideOnOverlappingShifts":{"type":"boolean","description":"Allow override on overlapping shifts","example":true},"weekStart":{"type":"string","description":"First day of the week","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":"MONDAY"},"unsocialTimeThreshold":{"type":"string","description":"Unsocial time threshold","example":"3.34"},"unsocialTimeThresholdType":{"type":"string","description":"How the unsocial time threshold is applied","enum":["PER_WEEK","PER_SCHEDULE_PERIOD"],"example":"PER_WEEK"},"unsocialTimeThresholdDays":{"type":"string","description":"Number of days the threshold is measured over","example":"7"},"unsocialTimeThresholdMaxDays":{"type":"string","description":"Maximum days","example":"5"},"unsocialTimeThresholdMaxHours":{"type":"string","description":"With over hours","example":"4"},"useXandVDays":{"type":"boolean","description":"Use special X and V days logic","example":false},"shiftMinLengths":{"type":"array","description":"Minimum shift length rules for this agreement, ordered by the time of day each rule starts to apply. At most 30 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_ShiftMinLengthRow"},"maxItems":30}}}},"components/schemas/employee_SalaryAdjustmentsSection":{"id":"components/schemas/employee_SalaryAdjustmentsSection","kind":"json-schema","title":"employee_SalaryAdjustmentsSection","data":{"type":"object","properties":{"employeeAge":{"$ref":"#/components/schemas/employee_EmployeeAgeSection"},"yearsWorked":{"$ref":"#/components/schemas/employee_YearsWorkedSection"},"personalSalaryAdditionSettings":{"type":"array","description":"Personal salary addition settings for this agreement, oldest first. The row that has no start date applies from the beginning of time and is returned first. At most 50 are returned; when an agreement holds more, the earliest 50 are returned and the most recent are omitted.","items":{"$ref":"#/components/schemas/employee_PersonalSalaryAdditionRow"},"maxItems":50}}}},"components/schemas/employee_SalaryRow":{"id":"components/schemas/employee_SalaryRow","kind":"json-schema","title":"employee_SalaryRow","data":{"type":"object","properties":{"startDate":{"type":"string","format":"date","description":"Start of the salary period. Omitted for the initial period.","example":"2025-02-01"},"monthlySalary":{"type":"string","description":"Monthly salary, applies to employmentType MONTHLY","example":"1800.0"},"divisor":{"type":"string","description":"Custom divisor, applies to employmentType MONTHLY","example":"2.0"},"hourlySalary":{"type":"string","description":"Hourly salary, applies to employmentType HOURLY (auto-calculated for MONTHLY)","example":"400.0"}}}},"components/schemas/employee_SalarySection":{"id":"components/schemas/employee_SalarySection","kind":"json-schema","title":"employee_SalarySection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the salary values are inherited from the template","example":true},"employmentType":{"type":"string","description":"Employment type","enum":["HOURLY","MONTHLY"],"example":"MONTHLY"},"salaries":{"type":"array","description":"Salary rows for this agreement, oldest first. The row that has no start date applies from the beginning of time and is returned first. At most 200 are returned; when an agreement holds more, the earliest 200 are returned and the most recent are omitted.","items":{"$ref":"#/components/schemas/employee_SalaryRow"},"maxItems":200}}}},"components/schemas/employee_ScheduleChangesSection":{"id":"components/schemas/employee_ScheduleChangesSection","kind":"json-schema","title":"employee_ScheduleChangesSection","data":{"type":"object","properties":{"scheduleLockPeriod":{"type":"string","description":"Lock schedule for changes","example":"0"},"scheduleLockPeriodType":{"type":"string","description":"Unit of the schedule lock period","enum":["MONTHS","WEEKS","DAYS"],"example":"DAYS"}}}},"components/schemas/employee_SchedulePeriodSection":{"id":"components/schemas/employee_SchedulePeriodSection","kind":"json-schema","title":"employee_SchedulePeriodSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the schedule period values are inherited from the template","example":true},"period":{"type":"string","description":"Schedule period unit","enum":["MONTHS","DAYS"],"example":"MONTHS"},"length":{"type":"string","description":"Number of months or days in the schedule period","example":"1"},"startDate":{"type":"string","format":"date","description":"Start of the schedule period","example":"2025-05-01"},"workingHours":{"$ref":"#/components/schemas/employee_WorkingHoursSection"},"advancedCalculation":{"$ref":"#/components/schemas/employee_AdvancedCalculationSection"},"nominalDaysPerWeek":{"type":"array","description":"Nominal days per week rows for this agreement, oldest first. The row that has no start date applies from the beginning of time and is returned first. At most 50 are returned; when an agreement holds more, the earliest 50 are returned and the most recent are omitted.","items":{"$ref":"#/components/schemas/employee_NominalDaysPerWeekRow"},"maxItems":50},"minAvailabilityHoursPerWeek":{"type":"string","description":"Minimum required availability hours per week","example":"10.23"}}}},"components/schemas/employee_ShiftMinLengthRow":{"id":"components/schemas/employee_ShiftMinLengthRow","kind":"json-schema","title":"employee_ShiftMinLengthRow","data":{"type":"object","properties":{"startTime":{"type":"string","description":"From time","example":"00:00:00"},"endTime":{"type":"string","description":"To time","example":"08:00:00"},"length":{"type":"string","description":"Minimum shift length in hours","example":"4.0"}}}},"components/schemas/employee_SocialCostRow":{"id":"components/schemas/employee_SocialCostRow","kind":"json-schema","title":"employee_SocialCostRow","data":{"type":"object","properties":{"type":{"type":"string","description":"Cost type","enum":["SOCIAL","ABSENCE"],"example":"SOCIAL"},"startAge":{"type":"string","description":"Age the cost applies from","example":"0"},"endAge":{"type":"string","description":"Age the cost applies to","example":"1"},"startType":{"type":"string","description":"Point in the year the cost starts on","enum":["BIRTHDAY","YEAR"],"example":"BIRTHDAY"},"percent":{"type":"string","description":"Cost percentage","example":"100.0"}}}},"components/schemas/employee_SocialCostsSection":{"id":"components/schemas/employee_SocialCostsSection","kind":"json-schema","title":"employee_SocialCostsSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"costs":{"type":"array","description":"Social cost rows for this agreement, ordered by the age range they cover, lowest start age first. At most 50 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_SocialCostRow"},"maxItems":50},"noCostPeriodStartDay":{"type":"integer","format":"int32","description":"Day of the month the no-cost period starts on","example":2},"noCostPeriodStartMonth":{"type":"string","description":"Month the no-cost period starts in","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"],"example":"JANUARY"},"noCostPeriodEndDay":{"type":"integer","format":"int32","description":"Day of the month the no-cost period ends on","example":7},"noCostPeriodEndMonth":{"type":"string","description":"Month the no-cost period ends in","enum":["JANUARY","FEBRUARY","MARCH","APRIL","MAY","JUNE","JULY","AUGUST","SEPTEMBER","OCTOBER","NOVEMBER","DECEMBER"],"example":"MARCH"}}}},"components/schemas/employee_TimeSection":{"id":"components/schemas/employee_TimeSection","kind":"json-schema","title":"employee_TimeSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"rulesForTimePunching":{"$ref":"#/components/schemas/employee_RulesForTimePunchingSection"},"overtimeAndUnsocialTime":{"$ref":"#/components/schemas/employee_OvertimeAndUnsocialTimeSection"},"punchAndWebpunchDeviations":{"$ref":"#/components/schemas/employee_PunchAndWebpunchDeviationsSection"}}}},"components/schemas/employee_WorkingHoursSection":{"id":"components/schemas/employee_WorkingHoursSection","kind":"json-schema","title":"employee_WorkingHoursSection","data":{"type":"object","properties":{"nominalHoursTypeDistribution":{"type":"string","description":"How full-time working hours are distributed","enum":["EQUAL_DISTRIBUTION_LEGACY","CUSTOM_DAILY_DISTRIBUTION","EQUAL_DISTRIBUTION"],"example":"EQUAL_DISTRIBUTION"},"fullEmploymentHours":{"type":"string","description":"Full-time employment hours","example":"37.5"},"fullEmploymentDays":{"type":"string","description":"Full-time employment days","example":"7.0"},"fullEmploymentDaysPerWeek":{"type":"string","description":"Full-time employment days per week","example":"5"},"dailyWorkingHours":{"type":"array","description":"Daily working hours rows for this agreement, in week order from Monday. At most 200 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_DailyWorkingHoursRow"},"maxItems":200}}}},"components/schemas/employee_WorkingTimeAndScheduleChangesSection":{"id":"components/schemas/employee_WorkingTimeAndScheduleChangesSection","kind":"json-schema","title":"employee_WorkingTimeAndScheduleChangesSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the working time and schedule change values are inherited from the template","example":false},"rulesForWorkingTime":{"$ref":"#/components/schemas/employee_RulesForWorkingTimeSection"},"breakRulesAndScheduleChanges":{"$ref":"#/components/schemas/employee_BreakRulesAndScheduleChangesSection"}}}},"components/schemas/employee_YearsWorkedSection":{"id":"components/schemas/employee_YearsWorkedSection","kind":"json-schema","title":"employee_YearsWorkedSection","data":{"type":"object","properties":{"useTemplate":{"type":"boolean","description":"Whether the template values are used for this section","example":false},"salaryAdditionCalcMode":{"type":"string","description":"Starting point for calculation","enum":["SAME_CALENDAR_MONTH","EXACT_CALENDAR_DAY","NEXT_CALENDAR_MONTH","SAME_CALENDAR_MONTH_INDUSTRY_START_DATE","EXACT_CALENDAR_DAY_INDUSTRY_START_DATE","NEXT_CALENDAR_MONTH_INDUSTRY_START_DATE"],"example":"SAME_CALENDAR_MONTH"},"employmentTenureSalaryAdditions":{"type":"array","description":"Employment tenure based salary additions for this agreement, fewest years worked first. At most 50 are returned; any beyond that are omitted from the response.","items":{"$ref":"#/components/schemas/employee_EmploymentTenureSalaryAdditionRow"},"maxItems":50}}}},"components/schemas/organisation_CreateGroupRequest":{"id":"components/schemas/organisation_CreateGroupRequest","kind":"json-schema","title":"organisation_CreateGroupRequest","data":{"type":"object","description":"Request payload used to create a new group","properties":{"name":{"type":"string","description":"The name of the group","example":"Engineering","maxLength":50,"minLength":0},"groupType":{"type":"string","description":"Type of group","enum":["DISTRICT","UNIT","SECTION"],"example":"UNIT","minLength":1},"parentGroupId":{"type":"string","description":"Identifier of the parent group","example":"10"},"managerId":{"type":"string","description":"Employee ID of the group manager","example":"1001"},"costCentreId":{"type":"string","description":"Associated cost centre identifier","example":"200"},"xrefIds":{"type":"array","description":"External reference identifiers","example":["AD-ENG","COST-ENG-01"],"items":{"type":"string"},"maxItems":50,"minItems":0}},"required":["groupType","name","parentGroupId"]}},"components/schemas/organisation_ProblemDetail":{"id":"components/schemas/organisation_ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","description":"RFC 9457 Problem Details for HTTP APIs","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/error-type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Error Title"},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":404},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","example":"A detailed explanation of the error"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/api/endpoint"}},"required":["status","title","type"],"title":"ProblemDetail"}},"components/schemas/organisation_ValidationError":{"id":"components/schemas/organisation_ValidationError","kind":"json-schema","title":"ValidationError","data":{"type":"object","description":"Validation errors, conforming to RFC 9457.","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/validation-error"},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","example":"The request is not valid."},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":422},"errors":{"type":"array","description":"A list of validation errors.","items":{"$ref":"#/components/schemas/organisation_ValidationErrorDetail"},"maxItems":50,"minItems":1},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/endpoint"}},"required":["errors","status","title","type"],"title":"ValidationError"}},"components/schemas/organisation_ValidationErrorDetail":{"id":"components/schemas/organisation_ValidationErrorDetail","kind":"json-schema","title":"organisation_ValidationErrorDetail","data":{"type":"object","description":"A single validation error.","properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"name is mandatory"},"pointer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON Pointer [RFC6901] to the associated entity in the request body."},"children":[]}]}]}],"example":"#/name"}}}},"components/schemas/organisation_GroupResponse":{"id":"components/schemas/organisation_GroupResponse","kind":"json-schema","title":"organisation_GroupResponse","data":{"type":"object","description":"Represents a group within the organization hierarchy","properties":{"id":{"type":"string","description":"Unique identifier of the group","example":"42"},"name":{"type":"string","description":"The name of the group","example":"Engineering","maxLength":50,"minLength":0},"groupType":{"type":"string","description":"Type of group","enum":["DISTRICT","UNIT","SECTION"],"example":"UNIT"},"parentGroupId":{"type":"string","description":"Identifier of the parent group","example":"10"},"managerId":{"type":"string","description":"Employee ID of the group manager","example":"1001"},"costCentreId":{"type":"string","description":"Associated cost centre identifier","example":"200"},"xrefIds":{"type":"array","description":"External reference identifiers","example":["AD-ENG","COST-ENG-01"],"items":{"type":"string"},"maxItems":50,"minItems":0},"created":{"type":"string","format":"date-time","description":"ISO-8601 timestamp when the group was created","example":"2024-01-10T09:15:30Z"},"updated":{"type":"string","format":"date-time","description":"ISO-8601 timestamp when the group was last updated","example":"2024-01-12T17:42:10Z"}}}},"components/schemas/organisation_CursorPageGroupResponse":{"id":"components/schemas/organisation_CursorPageGroupResponse","kind":"json-schema","title":"organisation_CursorPageGroupResponse","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/organisation_GroupResponse"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/organisation_CursorPaginationInfo"}}}},"components/schemas/organisation_CursorPaginationInfo":{"id":"components/schemas/organisation_CursorPaginationInfo","kind":"json-schema","title":"organisation_CursorPaginationInfo","data":{"type":"object","description":"Pagination information for cursor-based pagination.","properties":{"nextPageToken":{"type":"string","description":"The token for the next page","example":"eyJpZCI6MTIwfQ"},"previousPageToken":{"type":"string","description":"The token for the previous page","example":"eyJpZCI6ODB9"}}}},"components/schemas/rest-api-uaa_OAuth2TokenRequest":{"id":"components/schemas/rest-api-uaa_OAuth2TokenRequest","kind":"json-schema","title":"rest-api-uaa_OAuth2TokenRequest","data":{"type":"object","description":"OAuth2 client credentials token request","properties":{"grant_type":{"type":"string","description":"OAuth2 grant type","example":"client_credentials","minLength":1},"client_id":{"type":"string","description":"Client identifier","example":"my-client-id","minLength":1},"client_secret":{"type":"string","description":"Client secret","example":"my-client-secret","minLength":1},"scope":{"type":"string","description":"Space-delimited subset of the originally granted scopes. Allows the client to request a narrower set of permissions for the issued access token. If omitted, all originally authorized scopes apply.","example":"organization:groups:read organization:groups:create"}},"required":["client_id","client_secret","grant_type"]}},"components/schemas/rest-api-uaa_OAuth2ErrorResponse":{"id":"components/schemas/rest-api-uaa_OAuth2ErrorResponse","kind":"json-schema","title":"rest-api-uaa_OAuth2ErrorResponse","data":{"type":"object","description":"OAuth2 error response per RFC 6749","properties":{"error":{"type":"string","description":"An error code defined in RFC 6749 or other extensions","example":"invalid_client"},"error_description":{"type":"string","description":"A short description of what caused this error. Sometimes this contains dynamically-generated information about your specific error.","example":"Client not found: my-client-id"}}}},"components/schemas/rest-api-uaa_OAuth2TokenResponse":{"id":"components/schemas/rest-api-uaa_OAuth2TokenResponse","kind":"json-schema","title":"rest-api-uaa_OAuth2TokenResponse","data":{"type":"object","description":"OAuth2 token response","properties":{"access_token":{"type":"string","description":"The access token","example":"eyJhbGciOiJSUzI1NiJ9...","minLength":1},"token_type":{"type":"string","description":"Token type","example":"Bearer","minLength":1},"expires_in":{"type":"integer","format":"int64","description":"Token validity in seconds","example":3600},"scope":{"type":"string","description":"Granted scope","example":"organization:groups:read organization:groups:create","minLength":1}},"required":["access_token","expires_in","scope","token_type"]}},"components/schemas/security_RoleAssignmentRequest":{"id":"components/schemas/security_RoleAssignmentRequest","kind":"json-schema","title":"security_RoleAssignmentRequest","data":{"type":"object","description":"Request body for creating a role assignment","properties":{"employeeId":{"type":"string","description":"Employee identifier. Supports badgeNumber: prefix.","examples":["10","badgeNumber:EMP001"]},"groupId":{"type":"string","description":"Group identifier. Supports xrefId: prefix.","examples":["10","xrefId:GRP-16"]},"roleId":{"type":"string","description":"Role identifier. Supports xrefId: prefix.","examples":["10","xrefId:admin"]},"startDate":{"type":"string","format":"date","description":"Start date of the assignment. Defaults to today.","example":"2025-10-01"},"endDate":{"type":"string","format":"date","description":"End date of the assignment. Defaults to null.","example":"2026-01-01"}},"required":["employeeId","groupId","roleId"]}},"components/schemas/security_ProblemDetail":{"id":"components/schemas/security_ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","description":"RFC 9457 Problem Details for HTTP APIs","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/error-type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Error Title"},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":404},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","example":"A detailed explanation of the error"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/api/endpoint"}},"required":["status","title","type"],"title":"ProblemDetail"}},"components/schemas/security_ValidationError":{"id":"components/schemas/security_ValidationError","kind":"json-schema","title":"ValidationError","data":{"type":"object","description":"Validation errors, conforming to RFC 9457.","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/validation-error"},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","example":"The request is not valid."},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":422},"errors":{"type":"array","description":"A list of validation errors.","items":{"$ref":"#/components/schemas/security_ValidationErrorDetail"},"maxItems":50,"minItems":1},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/endpoint"}},"required":["errors","status","title","type"],"title":"ValidationError"}},"components/schemas/security_ValidationErrorDetail":{"id":"components/schemas/security_ValidationErrorDetail","kind":"json-schema","title":"security_ValidationErrorDetail","data":{"type":"object","description":"A single validation error.","properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"name is mandatory"},"pointer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON Pointer [RFC6901] to the associated entity in the request body."},"children":[]}]}]}],"example":"#/name"}}}},"components/schemas/security_RoleAssignmentResponse":{"id":"components/schemas/security_RoleAssignmentResponse","kind":"json-schema","title":"security_RoleAssignmentResponse","data":{"type":"object","description":"Represents a role assignment","properties":{"id":{"type":"string","description":"Unique identifier of the role assignment","example":"12345"},"employeeId":{"type":"string","description":"Employee identifier","example":"12345"},"groupId":{"type":"string","description":"Group identifier","example":"16"},"roleId":{"type":"string","description":"Role identifier","example":"12"},"startDate":{"type":"string","format":"date","description":"Start date of the assignment","example":"2025-10-01"},"endDate":{"type":"string","format":"date","description":"End date of the assignment","example":"2026-12-31"},"created":{"type":"string","format":"date-time","description":"Creation timestamp","example":"2025-10-01T14:18:41Z"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp","example":"2025-10-16T09:34:27Z"}}}},"components/schemas/security_RoleAssignmentUpdateRequest":{"id":"components/schemas/security_RoleAssignmentUpdateRequest","kind":"json-schema","title":"security_RoleAssignmentUpdateRequest","data":{"type":"object","description":"Request to update a role assignment","properties":{"startDate":{"type":"string","format":"date","description":"Start date of the assignment","example":"2026-06-01"},"endDate":{"type":"string","format":"date","description":"End date of the assignment","example":"2026-12-31"}}}},"components/schemas/security_CursorPageRoleResponse":{"id":"components/schemas/security_CursorPageRoleResponse","kind":"json-schema","title":"security_CursorPageRoleResponse","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/security_RoleResponse"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/security_CursorPaginationInfo"}}}},"components/schemas/security_CursorPaginationInfo":{"id":"components/schemas/security_CursorPaginationInfo","kind":"json-schema","title":"security_CursorPaginationInfo","data":{"type":"object","description":"Pagination information for cursor-based pagination.","properties":{"nextPageToken":{"type":"string","description":"The token for the next page","example":"eyJpZCI6MTIwfQ"},"previousPageToken":{"type":"string","description":"The token for the previous page","example":"eyJpZCI6ODB9"}}}},"components/schemas/security_RoleResponse":{"id":"components/schemas/security_RoleResponse","kind":"json-schema","title":"security_RoleResponse","data":{"type":"object","description":"Represents a role within the organization","properties":{"id":{"type":"string","description":"Unique identifier of the role","example":"42"},"name":{"type":"string","description":"The name of the role","example":"Manager"},"xrefId":{"type":"string","description":"External reference identifier","example":"ext-role-123"},"levelId":{"type":"string","description":"Identifier of the associated level (rank)","example":"5"}}}},"components/schemas/security_CursorPageRoleAssignmentResponse":{"id":"components/schemas/security_CursorPageRoleAssignmentResponse","kind":"json-schema","title":"security_CursorPageRoleAssignmentResponse","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/security_RoleAssignmentResponse"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/security_CursorPaginationInfo"}}}},"components/schemas/shifts_ProblemDetail":{"id":"components/schemas/shifts_ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","description":"RFC 9457 Problem Details for HTTP APIs","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/error-type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Error Title"},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":404},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","example":"A detailed explanation of the error"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/api/endpoint"}},"required":["status","title","type"],"title":"ProblemDetail"}},"components/schemas/shifts_ValidationError":{"id":"components/schemas/shifts_ValidationError","kind":"json-schema","title":"ValidationError","data":{"type":"object","description":"Validation errors, conforming to RFC 9457.","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developer.quinyx.com/api/problems/validation-error"},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","example":"The request is not valid."},"status":{"type":"integer","format":"int32","description":"The HTTP status code","example":422},"errors":{"type":"array","description":"A list of validation errors.","items":{"$ref":"#/components/schemas/shifts_ValidationErrorDetail"},"maxItems":50,"minItems":1},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/api/endpoint"}},"required":["errors","status","title","type"],"title":"ValidationError"}},"components/schemas/shifts_ValidationErrorDetail":{"id":"components/schemas/shifts_ValidationErrorDetail","kind":"json-schema","title":"shifts_ValidationErrorDetail","data":{"type":"object","description":"A single validation error.","properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"name is mandatory"},"pointer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON Pointer [RFC6901] to the associated entity in the request body."},"children":[]}]}]}],"example":"#/name"}}}},"components/schemas/shifts_CursorPageShift":{"id":"components/schemas/shifts_CursorPageShift","kind":"json-schema","title":"shifts_CursorPageShift","data":{"type":"object","description":"A page of data along with pagination information for cursor-based pagination.","properties":{"data":{"type":"array","description":"The data in the page.","items":{"$ref":"#/components/schemas/shifts_Shift"},"maxItems":100},"pagination":{"$ref":"#/components/schemas/shifts_CursorPaginationInfo"}}}},"components/schemas/shifts_CursorPaginationInfo":{"id":"components/schemas/shifts_CursorPaginationInfo","kind":"json-schema","title":"shifts_CursorPaginationInfo","data":{"type":"object","description":"Pagination information for cursor-based pagination.","properties":{"nextPageToken":{"type":"string","description":"The token for the next page","example":"eyJpZCI6MTIwfQ"},"previousPageToken":{"type":"string","description":"The token for the previous page","example":"eyJpZCI6ODB9"}}}},"components/schemas/shifts_Shift":{"id":"components/schemas/shifts_Shift","kind":"json-schema","title":"shifts_Shift","data":{"type":"object","description":"Represents a scheduled shift for an employee within a group","properties":{"id":{"type":"string","description":"Internal numeric ID of the shift","example":"123456789"},"xrefId":{"type":"string","description":"External reference ID of the shift.","example":"ext-shift-001"},"groupId":{"type":"string","description":"ID of the group this shift belongs to","example":"42"},"begin":{"type":"string","format":"date-time","description":"Start date and time of the shift","example":"2024-06-01T08:00:00Z"},"end":{"type":"string","format":"date-time","description":"End date and time of the shift","example":"2024-06-01T16:00:00Z"},"status":{"type":"string","description":"Current status of the shift","example":"ASSIGNED"},"deleted":{"type":"boolean","description":"Indicates whether the shift has been soft-deleted","example":false},"shiftTypeId":{"type":"string","description":"ID of the shift type associated with this shift","example":"7"},"employeeId":{"type":"string","description":"ID of the employee assigned to this shift. Use prefix 'badgeNumber:' when filtering","example":"99"},"countScheduleHours":{"type":"boolean","description":"Whether the shift hours count toward scheduled hours","example":true},"countWorkedHours":{"type":"boolean","description":"Whether the shift hours count toward worked hours","example":true},"freeDay":{"type":"boolean","description":"Indicates whether this shift represents a free/day-off day","example":false},"productiveTime":{"type":"string","description":"Productive time","example":"SCHEDULED_TIME"},"comment":{"type":"string","description":"Optional comment or note attached to the shift","example":"Morning shift - opening duties"},"costCentreId":{"type":"string","description":"ID of the cost centre associated with this shift","example":"5"},"projectId":{"type":"string","description":"ID of the project associated with this shift","example":"12"},"agreementId":{"type":"string","description":"ID of the agreement governing this shift","example":"3"},"scheduledDuration":{"type":"string","description":"Total scheduled duration of the shift in ISO-8601 duration format","example":"PT8H"},"created":{"type":"string","format":"date-time","description":"Timestamp when the shift was created","example":"2024-01-15T10:30:00Z"},"updated":{"type":"string","format":"date-time","description":"Timestamp when the shift was last updated","example":"2024-05-20T14:00:00Z"},"breaks":{"type":"array","description":"List of breaks within the shift","items":{"$ref":"#/components/schemas/shifts_Task"},"maxItems":20},"tasks":{"type":"array","description":"List of tasks assigned within the shift","items":{"$ref":"#/components/schemas/shifts_TaskIntegrationModel"},"maxItems":100},"additionalTimeLevel":{"type":"string","description":"Additional time level on a shift","example":"4"}}}},"components/schemas/shifts_Task":{"id":"components/schemas/shifts_Task","kind":"json-schema","title":"shifts_Task","data":{"type":"object","description":"Represents a task segment within a shift","properties":{"begin":{"type":"string","format":"date-time","description":"Start date and time of the break","example":"2024-06-01T12:00:00Z"},"end":{"type":"string","format":"date-time","description":"End date and time of the break","example":"2024-06-01T12:30:00Z"}}}},"components/schemas/shifts_TaskIntegrationModel":{"id":"components/schemas/shifts_TaskIntegrationModel","kind":"json-schema","title":"shifts_TaskIntegrationModel","data":{"type":"object","description":"Represents a task segment within a shift","properties":{"id":{"type":"string","description":"Internal numeric ID of the task","example":"987654321"},"shiftTypeId":{"type":"string","description":"ID of the shift type associated with this task","example":"7"},"begin":{"type":"string","format":"date-time","description":"Start date and time of the task","example":"2024-06-01T08:00:00Z"},"end":{"type":"string","format":"date-time","description":"End date and time of the task","example":"2024-06-01T10:00:00Z"},"countAsScheduledHours":{"type":"boolean","description":"Whether this task's hours count toward scheduled hours","example":true},"countAsWorkedHours":{"type":"boolean","description":"Whether this task's hours count toward worked hours","example":true},"productiveTime":{"type":"string","description":"Productive time","example":"ALWAYS"},"costCentreId":{"type":"string","description":"ID of the cost centre associated with this task","example":"5"},"projectId":{"type":"string","description":"ID of the project associated with this task","example":"12"},"comment":{"type":"string","description":"Optional comment or note attached to the task","example":"Customer service desk coverage"}}}},"schema_141":{"kind":"json-schema","data":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'xrefId:'.","example":"xrefId:f47ac10b-58cc-3","pattern":"^xrefId:[a-zA-Z0-9._-]{1,64}$"}]},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/organisation_ProblemDetail"},{"$ref":"#/components/schemas/organisation_ValidationError"}]},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"string","example":"eyJpZCI6MTAwfQ"},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":50,"example":50,"maximum":100,"minimum":1},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for id with operator IN","items":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource."},{"type":"string","description":"The external string ID, which must start with 'xrefId:'.","example":"xrefId:example-external-id","pattern":"^xrefId:[a-zA-Z0-9._-]{1,64}$"}]},"maxItems":50},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/security_ProblemDetail"},{"$ref":"#/components/schemas/security_ValidationError"}]},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'xrefId:'.","example":"xrefId:f47ac10b-58cc-4","pattern":"^xrefId:[a-zA-Z0-9._-]{1,64}$"}]},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'badgeNumber:'.","example":"badgeNumber:1234","pattern":"^badgeNumber:[a-zA-Z0-9._-]{1,64}$"}]},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/employee_ProblemDetail"},{"$ref":"#/components/schemas/employee_ValidationError"}]},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"},"maxItems":50},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for id with operator IN","items":{"type":"string"},"maxItems":50},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for employeeId with operator IN","items":{"type":"string"},"maxItems":50},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for groupId with operator IN","items":{"type":"string"},"maxItems":50},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for roleId with operator IN","items":{"type":"string"},"maxItems":50},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"string"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for id with operator IN","items":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'xrefId:'.","example":"xrefId:example-external-id","pattern":"^xrefId:[a-zA-Z0-9._-]{1,64}$"}]},"maxItems":50},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for groupId with operator IN","items":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'xrefId:'.","example":"xrefId:example-external-id","pattern":"^xrefId:[a-zA-Z0-9._-]{1,64}$"}]},"maxItems":50},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for employeeId with operator IN","items":{"description":"An identifier that can be either a Quinyx ID or a prefixed external ID string.","oneOf":[{"type":"string","description":"The Quinyx ID of the resource.","pattern":"^[0-9]+$"},{"type":"string","description":"The external string ID, which must start with 'badgeNumber:'.","example":"badgeNumber:example-external-id","pattern":"^badgeNumber:[a-zA-Z0-9._-]{1,64}$"}]},"maxItems":50},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"array","description":"Multiple values for status with operator IN","items":{"type":"string"},"maxItems":50},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/shifts_ProblemDetail"},{"$ref":"#/components/schemas/shifts_ValidationError"}]},"id":"schema_161"}},"exampleStore":{"paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example":{"value":{"error":"unsupported_grant_type","error_description":"Unsupported grant type: invalid_type"},"id":"paths/~1oauth~1v3~1token/post/responses/400/content/application~1json/example"},"paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example":{"value":{"error":"invalid_client","error_description":"Client not found: my-client-id"},"id":"paths/~1oauth~1v3~1token/post/responses/401/content/application~1json/example"},"paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example":{"value":{"error":"server_error","error_description":"Token generation failed"},"id":"paths/~1oauth~1v3~1token/post/responses/500/content/application~1json/example"},"paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/groups/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/groups/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/organization/v3/groups/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/groups/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/organization/v3/groups/{id}"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/organization/v3/groups/{id}"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/groups/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/groups/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/organization/v3/groups/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/groups/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/groups/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/groups/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/organization/v3/groups/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/groups/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/organization/v3/groups"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/organization/v3/groups"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1organization~1v3~1groups/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/groups"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/groups"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/groups"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/organization/v3/groups"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/organization/v3/groups"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1organization~1v3~1groups/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/groups"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/groups"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/post/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/groups"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1groups/post/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/organization/v3/roles"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/organization/v3/roles"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1organization~1v3~1roles/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/roles"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/roles"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/roles"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/organization/v3/roles/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/organization/v3/roles/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/organization/v3/roles/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/organization/v3/roles/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1organization~1v3~1roles~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/employees/{id}"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/employees/{id}"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/employees/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/employees/{id}"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/employees/{id}"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/employees/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/put/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/employees/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/employees/{id}"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/employees/{id}"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/employees/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/employees"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/employees"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1employees/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/employees"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/employees"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1employees/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/employees"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/employees"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/post/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/employees"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1employees/post/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/role-assignments"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/role-assignments"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1role-assignments/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/role-assignments"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/role-assignments"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/role-assignments"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/get/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/role-assignments"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/role-assignments"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1role-assignments/post/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/role-assignments"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/post/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/role-assignments"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/post/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/role-assignments"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/post/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/role-assignments"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments/post/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/role-assignments/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/role-assignments/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/role-assignments/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/role-assignments/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/delete/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/hr/v3/role-assignments/{id}"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/hr/v3/role-assignments/{id}"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/hr/v3/role-assignments/{id}"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/hr/v3/role-assignments/{id}"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound":{"value":{"type":"https://developer.quinyx.com/api/problems/not-found","title":"Not Found","status":404,"detail":"The requested resource was not found","instance":"/hr/v3/role-assignments/{id}"},"key":"notFound","summary":"Not found","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/404/content/application~1problem+json/examples/notFound"},"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/hr/v3/role-assignments/{id}"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1hr~1v3~1role-assignments~1{id}/patch/responses/500/content/application~1problem+json/examples/serverError"},"paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"detail":"The request is invalid or malformed","instance":"/schedule/v3/shifts"},"key":"badRequestProblemDetail","summary":"Bad request","description":"Example ProblemDetail response","id":"paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestProblemDetail"},"paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError":{"value":{"type":"https://developer.quinyx.com/api/problems/bad-request","title":"Bad Request","status":400,"errors":[{"detail":"name is mandatory","pointer":"#/name"}],"instance":"/schedule/v3/shifts"},"key":"badRequestValidationError","summary":"Bad request","description":"Example ValidationError response","id":"paths/~1schedule~1v3~1shifts/get/responses/400/content/application~1problem+json/examples/badRequestValidationError"},"paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized":{"value":{"type":"https://developer.quinyx.com/api/problems/unauthorized","title":"Unauthorized","status":401,"detail":"Access token not set or invalid, and the requested resource could not be returned","instance":"/schedule/v3/shifts"},"key":"unauthorized","summary":"Unauthorized","description":"Example ProblemDetail response","id":"paths/~1schedule~1v3~1shifts/get/responses/401/content/application~1problem+json/examples/unauthorized"},"paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden":{"value":{"type":"https://developer.quinyx.com/api/problems/forbidden","title":"Forbidden","status":403,"detail":"The resource could not be returned as the requestor is not authorized","instance":"/schedule/v3/shifts"},"key":"forbidden","summary":"Forbidden","description":"Example ProblemDetail response","id":"paths/~1schedule~1v3~1shifts/get/responses/403/content/application~1problem+json/examples/forbidden"},"paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError":{"value":{"type":"https://developer.quinyx.com/api/problems/server-error","title":"Server Error","status":500,"detail":"The server encountered an unexpected error","instance":"/schedule/v3/shifts"},"key":"serverError","summary":"Server error","description":"Example ProblemDetail response","id":"paths/~1schedule~1v3~1shifts/get/responses/500/content/application~1problem+json/examples/serverError"}},"securitySchemeStore":{"OAuth2ClientCredentials":{"id":"OAuth2ClientCredentials","type":"oauth2","description":"OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/v3/authentication","flows":{"clientCredentials":{"tokenUrl":"/oauth/v3/token","scopes":{"hr:agreements:delete":"","hr:agreements:read":"","hr:employees:create":"","hr:employees:delete":"","hr:employees:read":"","hr:employees:update":"","organization:groups:create":"","organization:groups:delete":"","organization:groups:read":"","organization:groups:update":"","hr:role-assignments:create":"","hr:role-assignments:delete":"","hr:role-assignments:read":"","hr:role-assignments:update":"","organization:roles:read":"","schedule:shifts:read":""}}}}},"servers":[{"url":"https://api.{region}.quinyx.com","description":"Production","variables":{"region":{"default":"eu","enum":["eu","na"]}}},{"url":"https://api.{region}.rc.quinyx.com","description":"RC","variables":{"region":{"default":"eu","enum":["eu","na"]}}}]},"options":{"hideDownloadButtons":true,"hideReplay":false,"hideSchemaTitles":true,"jsonSamplesExpandLevel":"all","schemasExpansionLevel":0,"codeSamples":{"skipOptionalParameters":true},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api/v3/specs/quinyx-public-api-v3.json?download"},{"url":"/_bundle/api/v3/specs/quinyx-public-api-v3.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Quinyx API","description":null}},"baseSlug":"/api/v3/specs/quinyx-public-api-v3","routesMapping":{}}