{"items":[{"type":"link","label":"Pave External API","link":"/apis","routeSlug":"/apis","content":{"contentType":"overview","meta":{"name":"Pave External API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Pave External API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Documentation for the Pave External API"}],"sectionId":"/apis"}],"sectionId":"/apis"}]}]}},{"type":"group","label":"Ping API","link":"/apis/ping-api","routeSlug":"/apis/ping-api","items":[{"label":"Test Endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/ping-api/pingcontroller_ping","routeSlug":"/apis/ping-api/pingcontroller_ping","metadata":{"seo":{"title":"Test Endpoint","description":"Test Endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PingController_ping","name":"Test Endpoint","isWebhook":false,"pointer":"/paths/~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API Key generated within the Pave App"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ping","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/ping","href":"ping-api/pingcontroller_ping","openApiOperationId":"PingController_ping","summary":"Test Endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns \"pong\" message on success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PingResponseDto","exampleIds":["paths/~1ping/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PingResponseDto","exampleIds":["paths/~1ping/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PingResponseDto","exampleIds":["paths/~1ping/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PingResponseDto","exampleIds":["paths/~1ping/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ping-api/pingcontroller_ping"}],"panels":[]}]},"httpPath":"/ping"}],"content":{"contentType":"group","meta":{"name":"Ping API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ping","summary":"Test Endpoint","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ping-api/pingcontroller_ping","deprecated":false}]}]}]}]}},{"type":"group","label":"Merit Cycle API","link":"/apis/merit-cycle-api","routeSlug":"/apis/merit-cycle-api","items":[{"label":"List Merit Cycles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merit-cycle-api/meritcyclecontroller_findall_v1","routeSlug":"/apis/merit-cycle-api/meritcyclecontroller_findall_v1","metadata":{"seo":{"title":"List Merit Cycles","description":"Returns a list of all merit cycles"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MeritCycleController_findAll_v1","name":"List Merit Cycles","isWebhook":false,"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Merit Cycles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all merit cycles"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API Key generated within the Pave App"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_0","description":"The status of the merit cycle"},{"name":"startDate","in":"query","schemaId":"schema_1","description":"The start date of the merit cycle"},{"name":"limit","in":"query","schemaId":"schema_2","description":"The number of merit cycles to return"},{"name":"nextCursor","in":"query","schemaId":"schema_3","description":"The next cursor to paginate through the list of merit cycles"}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/compensationPlanning/meritCycles","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_0"},{"name":"startDate","in":"query","required":false,"schemaId":"schema_1"},{"name":"limit","in":"query","required":false,"schemaId":"schema_2"},{"name":"nextCursor","in":"query","required":false,"example":"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/compensationPlanning/meritCycles","href":"merit-cycle-api/meritcyclecontroller_findall_v1","openApiOperationId":"MeritCycleController_findAll_v1","summary":"List Merit Cycles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of merit cycles on success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_4","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merit-cycle-api/meritcyclecontroller_findall_v1"}],"panels":[]}]},"httpPath":"/v1/compensationPlanning/meritCycles"},{"label":"Get a Merit Cycle by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merit-cycle-api/meritcyclecontroller_findbyid_v1","routeSlug":"/apis/merit-cycle-api/meritcyclecontroller_findbyid_v1","metadata":{"seo":{"title":"Get a Merit Cycle by ID","description":"Returns a single Merit Cycle by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MeritCycleController_findById_v1","name":"Get a Merit Cycle by ID","isWebhook":false,"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Merit Cycle by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single Merit Cycle by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API Key generated within the Pave App"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the Merit Cycle","required":true}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/compensationPlanning/meritCycles/{id}","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/compensationPlanning/meritCycles/{id}","href":"merit-cycle-api/meritcyclecontroller_findbyid_v1","openApiOperationId":"MeritCycleController_findById_v1","summary":"Get a Merit Cycle by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a Merit Cycle on success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeritCycleResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/MeritCycleResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MeritCycleResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeritCycleResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merit-cycle-api/meritcyclecontroller_findbyid_v1"}],"panels":[]}]},"httpPath":"/v1/compensationPlanning/meritCycles/{id}"},{"label":"Get Exchange Rates for a Merit Cycle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merit-cycle-api/meritcyclecontroller_getexchangerates_v1","routeSlug":"/apis/merit-cycle-api/meritcyclecontroller_getexchangerates_v1","metadata":{"seo":{"title":"Get Exchange Rates for a Merit Cycle","description":"Returns exchange rates for a merit cycle, relative to the merit cycle currency"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MeritCycleController_getExchangeRates_v1","name":"Get Exchange Rates for a Merit Cycle","isWebhook":false,"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Exchange Rates for a Merit Cycle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns exchange rates for a merit cycle, relative to the merit cycle currency"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API Key generated within the Pave App"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_5","description":"The ID of the Merit Cycle","required":true}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/compensationPlanning/meritCycles/{id}/exchangeRates","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/compensationPlanning/meritCycles/{id}/exchangeRates","href":"merit-cycle-api/meritcyclecontroller_getexchangerates_v1","openApiOperationId":"MeritCycleController_getExchangeRates_v1","summary":"Get Exchange Rates for a Merit Cycle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns exchange rates on success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeritCycleExchangeRatesResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/MeritCycleExchangeRatesResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Merit cycle not found"}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MeritCycleExchangeRatesResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MeritCycleExchangeRatesResponseDto","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merit-cycle-api/meritcyclecontroller_getexchangerates_v1"}],"panels":[]}]},"httpPath":"/v1/compensationPlanning/meritCycles/{id}/exchangeRates"}],"content":{"contentType":"group","meta":{"name":"Merit Cycle API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merit Cycle API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/compensationPlanning/meritCycles","summary":"List Merit Cycles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merit-cycle-api/meritcyclecontroller_findall_v1","deprecated":false},{"title":"/v1/compensationPlanning/meritCycles/{id}","summary":"Get a Merit Cycle by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merit-cycle-api/meritcyclecontroller_findbyid_v1","deprecated":false},{"title":"/v1/compensationPlanning/meritCycles/{id}/exchangeRates","summary":"Get Exchange Rates for a Merit Cycle","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merit-cycle-api/meritcyclecontroller_getexchangerates_v1","deprecated":false}]}]}]}]}},{"type":"group","label":"Merit Cycle Employee API","link":"/apis/merit-cycle-employee-api","routeSlug":"/apis/merit-cycle-employee-api","items":[{"label":"List Merit Cycle Employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1","routeSlug":"/apis/merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1","metadata":{"seo":{"title":"List Merit Cycle Employees","description":"Returns a list of all merit cycle employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MeritCycleEmployeeController_findAll_v1","name":"List Merit Cycle Employees","isWebhook":false,"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Merit Cycle Employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all merit cycle employees"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API Key generated within the Pave App"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"meritCycleId","in":"path","schemaId":"schema_5","description":"The ID of the Merit Cycle","required":true}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_2","description":"The number of merit cycle employees to return"},{"name":"nextCursor","in":"query","schemaId":"schema_3","description":"The next cursor to paginate through the list of merit cycle employees"}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/compensationPlanning/meritCycles/{meritCycleId}/employees","servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"parameters":{"path":[{"name":"meritCycleId","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_2"},{"name":"nextCursor","in":"query","required":false,"example":"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/compensationPlanning/meritCycles/{meritCycleId}/employees","href":"merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1","openApiOperationId":"MeritCycleEmployeeController_findAll_v1","summary":"List Merit Cycle Employees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of merit cycle employees on success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_6","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1"}],"panels":[]}]},"httpPath":"/v1/compensationPlanning/meritCycles/{meritCycleId}/employees"}],"content":{"contentType":"group","meta":{"name":"Merit Cycle Employee API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merit Cycle Employee API","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/compensationPlanning/meritCycles/{meritCycleId}/employees","summary":"List Merit Cycle Employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merit-cycle-employee-api/meritcycleemployeecontroller_findall_v1","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/PingResponseDto":{"id":"components/schemas/PingResponseDto","kind":"json-schema","title":"PingResponseDto","data":{"type":"object","properties":{"message":{"type":"string","description":"The message to return","example":"pong"}},"required":["message"]}},"components/schemas/PaginatedResponseDto":{"id":"components/schemas/PaginatedResponseDto","kind":"json-schema","title":"PaginatedResponseDto","data":{"type":"object","properties":{"nextCursor":{"type":"string","description":"The next cursor to use for pagination","example":"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ=="}}}},"components/schemas/MeritCycleResponseDto":{"id":"components/schemas/MeritCycleResponseDto","kind":"json-schema","title":"MeritCycleResponseDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Merit Cycle","example":"mc_12345678-1234-5678-9012-123456789012"},"name":{"type":"string","description":"The name of the Merit Cycle","example":"H1 Merit Cycle"},"startDate":{"format":"date-time","type":"string","description":"The start date of the Merit Cycle","example":"2025-01-01T00:00:00.000Z"},"endDate":{"format":"date-time","type":"string","description":"The end date of the Merit Cycle","example":"2025-01-31T00:00:00.000Z"},"createdDate":{"format":"date-time","type":"string","description":"The date the Merit Cycle was created","example":"2024-06-17T18:55:43.000Z"},"status":{"type":"string","description":"The status of the Merit Cycle","example":"active","enum":["active","inactive","finalized"]}},"required":["id","name","startDate","endDate","createdDate","status"]}},"components/schemas/MeritCycleExchangeRatesResponseDto":{"id":"components/schemas/MeritCycleExchangeRatesResponseDto","kind":"json-schema","title":"MeritCycleExchangeRatesResponseDto","data":{"type":"object","properties":{"base":{"type":"string","description":"The base currency of the exchange rates (merit cycle currency)","example":"USD"},"rates":{"type":"object","description":"Exchange rates from the base currency","example":{"EUR":0.92,"GBP":0.79,"JPY":149.5}}},"required":["base","rates"]}},"components/schemas/MeritCycleEmployeeColumnResponseDto":{"id":"components/schemas/MeritCycleEmployeeColumnResponseDto","kind":"json-schema","title":"MeritCycleEmployeeColumnResponseDto","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Merit Cycle Employee Column"},"type":{"type":"string","description":"The type of the Merit Cycle Employee Column (text, number, currency, boolean, composite)"},"value":{"description":"The value of the Merit Cycle Employee Column","oneOf":[{"type":"string","example":{"text":"Sales"}},{"type":"boolean","example":{"isPromotion":true}},{"type":"object","description":"Currency code value","properties":{"code":{"type":"string","description":"Currency Code according to ISO 4217"},"value":{"type":"string","description":"Readable Currency Name"}},"example":{"code":"USD","value":"United States Dollar"}},{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"object","description":"Currency code value","properties":{"code":{"type":"string","description":"Currency Code according to ISO 4217"},"value":{"type":"string","description":"Readable Currency Name"}}}]},"example":{"composite":{"fullName":"John Doe","jobLevel":"P4","jobTitle":"Sales Manager"}}}]}},"required":["name","type","value"]}},"components/schemas/MeritCycleEmployeeResponseDto":{"id":"components/schemas/MeritCycleEmployeeResponseDto","kind":"json-schema","title":"MeritCycleEmployeeResponseDto","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the Merit Cycle Employee","example":"mce_2312c64b-h5f1-46ca-8607-661a66319b91"},"email":{"type":"string","description":"The email of the Merit Cycle Employee","example":"john.doe@example.com"},"firstName":{"type":"string","description":"The first name of the Merit Cycle Employee","example":"John"},"lastName":{"type":"string","description":"The last name of the Merit Cycle Employee","example":"Doe"},"preferredName":{"type":"object","description":"The preferred name (if any) of the Merit Cycle Employee","example":"John","nullable":true},"currencyCode":{"type":"object","description":"The currency code of the Merit Cycle Employee","example":{"code":"USD","value":"United States Dollar"},"properties":{"code":{"type":"string","description":"Currency Code according to ISO 4217"},"value":{"type":"string","description":"Readable Currency Name"}}},"eligibilityStatus":{"type":"string","description":"The eligibility status of the Merit Cycle Employee","example":"eligible","enum":["eligible","ineligible"]},"columns":{"type":"object","description":"The columns of the Merit Cycle Employee","example":{"department":{"name":"Department","type":"text","value":"Sales"},"employee":{"name":"Employee","type":"composite","value":{"fullName":"John Doe","jobLevel":"P4","jobTitle":"Sales Manager"}}},"additionalProperties":{"$ref":"#/components/schemas/MeritCycleEmployeeColumnResponseDto"}}},"required":["id","email","firstName","lastName","preferredName","currencyCode","eligibilityStatus","columns"]}},"schema_0":{"kind":"json-schema","data":{"enum":["active","inactive","finalized"],"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"properties":{"gt":{"description":"Greater than the start date","type":"string","format":"YYYY-MM-DD","example":"2025-01-15"},"gte":{"description":"Greater than or equal to the start date","type":"string","format":"YYYY-MM-DD","example":"2025-01-15"},"lt":{"description":"Less than the start date","type":"string","format":"YYYY-MM-DD","example":"2025-01-15"},"lte":{"description":"Less than or equal to the start date","type":"string","format":"YYYY-MM-DD","example":"2025-01-15"}},"type":"object"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"maximum":100,"default":25,"type":"number"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"example":"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ==","type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeritCycleResponseDto"}}}}]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeritCycleEmployeeResponseDto"}}}}]},"id":"schema_6"}},"exampleStore":{"paths/~1ping/get/responses/200/content/application~1json/example":{"value":{"message":"pong"},"id":"paths/~1ping/get/responses/200/content/application~1json/example"},"paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"mc_12345678-1234-5678-9012-123456789012","name":"H1 Merit Cycle","startDate":"2025-01-01T00:00:00.000Z","endDate":"2025-01-31T00:00:00.000Z","createdDate":"2024-06-17T18:55:43.000Z","status":"active"}]},"id":"paths/~1v1~1compensationPlanning~1meritCycles/get/responses/200/content/application~1json/example"},"paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example":{"value":{"id":"mc_12345678-1234-5678-9012-123456789012","name":"H1 Merit Cycle","startDate":"2025-01-01T00:00:00.000Z","endDate":"2025-01-31T00:00:00.000Z","createdDate":"2024-06-17T18:55:43.000Z","status":"active"},"id":"paths/~1v1~1compensationPlanning~1meritCycles~1{id}/get/responses/200/content/application~1json/example"},"paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example":{"value":{"base":"USD","rates":{"EUR":0.92,"GBP":0.79,"JPY":149.5}},"id":"paths/~1v1~1compensationPlanning~1meritCycles~1{id}~1exchangeRates/get/responses/200/content/application~1json/example"},"paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"mce_2312c64b-h5f1-46ca-8607-661a66319b91","email":"pave.smith@pave.com","firstName":"Pave","lastName":"Smith","preferredName":null,"currencyCode":"USD","eligibilityStatus":"eligible","columns":{"department":{"type":"text","name":"Department","value":"Sales Operations"},"employee":{"type":"composite","name":"Employee","value":{"fullName":"Pave Smith","jobLevel":"P4","jobTitle":"Sales Operations Manager"}}}}],"nextCursor":"eyJleHRlcm5hbF9pZCI6Im1jZV8wNDdiZTg0ZC02OGQxLTRiMzYtYmU0Mi0xY2RlMTE4MjdhZTkifQ=="},"id":"paths/~1v1~1compensationPlanning~1meritCycles~1{meritCycleId}~1employees/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"api-key":{"id":"api-key","type":"apiKey","description":"API Key generated within the Pave App","in":"header","paramName":"x-api-key"}},"servers":[{"url":"https://api.pave.com","description":"Pave Production Server"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/index.json?download"},{"url":"/_bundle/apis/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Pave External API","description":"Documentation for the Pave External API"}},"baseSlug":"/apis","routesMapping":{}}