{"items":[{"type":"link","label":"Rhythms REST API","link":"/rest/v2","routeSlug":"/rest/v2","content":{"contentType":"overview","meta":{"name":"Rhythms REST API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.rhythms.ai"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Rhythms REST API (v2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The official REST API for Rhythms - designed for third-party integrations, mobile apps, and external tooling. This API follows REST conventions and provides clean, predictable endpoints for managing OKRs (Objectives, Key Results, and Initiatives)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://api.rhythms.ai"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All REST API v2 endpoints are prefixed with /rest/v2/"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All responses use JSON format with consistent error handling and pagination. Successful responses include requested data, while error responses provide detailed troubleshooting information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Handling"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API uses standard HTTP status codes with detailed JSON error messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perfect for building integrations, mobile apps, reporting dashboards, and automation workflows."},"children":[]}]}]}]}],"sectionId":"/rest/v2"}],"sectionId":"/rest/v2"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API endpoints require authentication using Bearer token authorization. Include this header with every request:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Bearer token for your account access"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting API Credentials: Contact support at support@rhythms.ai to obtain your access token."},"children":[]}]}]}]}],"sectionId":"/rest/v2/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard rate limits apply to all endpoints to ensure fair usage and optimal performance for all users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need higher limits for your integration, please contact our support team at support@rhythms.ai with details about your use case."},"children":[]}]}]}]}],"sectionId":"/rest/v2/section/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List endpoints support pagination using query parameters:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Page number (default: 1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Items per page (default: 20, max: 100)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response includes pagination metadata in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the next page number (or null if no more pages)."},"children":[]}]}]}]}],"sectionId":"/rest/v2/section/pagination"}]}]}},{"type":"link","label":"Authentication","link":"/rest/v2/section/authentication","routeSlug":"/rest/v2/section/authentication","content":null},{"type":"link","label":"Rate Limiting","link":"/rest/v2/section/rate-limiting","routeSlug":"/rest/v2/section/rate-limiting","content":null},{"type":"link","label":"Pagination","link":"/rest/v2/section/pagination","routeSlug":"/rest/v2/section/pagination","content":null},{"type":"group","label":"Checkins","link":"/rest/v2/checkins","routeSlug":"/rest/v2/checkins","items":[{"label":"List checkins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/checkins/get_rest_v2_checkins","routeSlug":"/rest/v2/checkins/get_rest_v2_checkins","metadata":{"seo":{"title":"List checkins","description":"Retrieves all checkins via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_checkins","name":"List checkins","isWebhook":false,"pointer":"/paths/~1rest~1v2~1checkins/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List checkins","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":"Retrieves all checkins via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, uuid, goal_uuid, creator_uuid, checkin_date, created_at, status, value, source_type."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1checkins/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/checkins","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["400","401","403","404","422","429","500"],"pointer":"/rest/v2/checkins","href":"checkins/get_rest_v2_checkins","openApiOperationId":"get_rest_v2_checkins","summary":"List checkins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1checkins/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkins/get_rest_v2_checkins"}],"panels":[]}]},"httpPath":"/rest/v2/checkins"},{"label":"Create a new checkin","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/checkins/post_rest_v2_checkins","routeSlug":"/rest/v2/checkins/post_rest_v2_checkins","metadata":{"seo":{"title":"Create a new checkin","description":"Creates a new checkin for a goal with optional value, status, and note"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_checkins","name":"Create a new checkin","isWebhook":false,"pointer":"/paths/~1rest~1v2~1checkins/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new checkin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new checkin for a goal with optional value, status, and note"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53","pointer":"/paths/~1rest~1v2~1checkins/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/checkins","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_53"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/checkins","href":"checkins/post_rest_v2_checkins","openApiOperationId":"post_rest_v2_checkins","summary":"Create a new checkin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}},"schemaId":"components/schemas/okrs_checkin","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1checkins/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_checkin","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkins/post_rest_v2_checkins"}],"panels":[]}]},"httpPath":"/rest/v2/checkins"},{"label":"Get a specific checkin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/checkins/get_rest_v2_checkins_id","routeSlug":"/rest/v2/checkins/get_rest_v2_checkins_id","metadata":{"seo":{"title":"Get a specific checkin","description":"Retrieves detailed information about a specific checkin by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_checkins_id","name":"Get a specific checkin","isWebhook":false,"pointer":"/paths/~1rest~1v2~1checkins~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific checkin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific checkin by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Checkin UUID","required":true}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/checkins/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/checkins/{id}","href":"checkins/get_rest_v2_checkins_id","openApiOperationId":"get_rest_v2_checkins_id","summary":"Get a specific checkin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}},"schemaId":"components/schemas/okrs_checkin","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_checkin","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkins/get_rest_v2_checkins_id"}],"panels":[]}]},"httpPath":"/rest/v2/checkins/{id}"},{"label":"Update a checkin","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/checkins/put_rest_v2_checkins_id","routeSlug":"/rest/v2/checkins/put_rest_v2_checkins_id","metadata":{"seo":{"title":"Update a checkin","description":"Updates an existing checkin with the specified attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_checkins_id","name":"Update a checkin","isWebhook":false,"pointer":"/paths/~1rest~1v2~1checkins~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a checkin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing checkin with the specified attributes"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Checkin UUID","required":true}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54","pointer":"/paths/~1rest~1v2~1checkins~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/checkins/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_54"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/checkins/{id}","href":"checkins/put_rest_v2_checkins_id","openApiOperationId":"put_rest_v2_checkins_id","summary":"Update a checkin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}},"schemaId":"components/schemas/okrs_checkin","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_checkin","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkins/put_rest_v2_checkins_id"}],"panels":[]}]},"httpPath":"/rest/v2/checkins/{id}"},{"label":"Delete a checkin","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/checkins/delete_rest_v2_checkins_id","routeSlug":"/rest/v2/checkins/delete_rest_v2_checkins_id","metadata":{"seo":{"title":"Delete a checkin","description":"Deletes a checkin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_checkins_id","name":"Delete a checkin","isWebhook":false,"pointer":"/paths/~1rest~1v2~1checkins~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a checkin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a checkin"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Checkin UUID","required":true}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/checkins/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/checkins/{id}","href":"checkins/delete_rest_v2_checkins_id","openApiOperationId":"delete_rest_v2_checkins_id","summary":"Delete a checkin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}},"schemaId":"components/schemas/okrs_checkin","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1checkins~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_checkin","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_checkin"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/checkins/delete_rest_v2_checkins_id"}],"panels":[]}]},"httpPath":"/rest/v2/checkins/{id}"}],"content":{"contentType":"group","meta":{"name":"Checkins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checkins","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/checkins","summary":"List checkins","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkins/get_rest_v2_checkins","deprecated":false},{"title":"/rest/v2/checkins","summary":"Create a new checkin","prefix":{"name":"post","color":"post"},"badges":[],"link":"/checkins/post_rest_v2_checkins","deprecated":false},{"title":"/rest/v2/checkins/{id}","summary":"Get a specific checkin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/checkins/get_rest_v2_checkins_id","deprecated":false},{"title":"/rest/v2/checkins/{id}","summary":"Update a checkin","prefix":{"name":"put","color":"put"},"badges":[],"link":"/checkins/put_rest_v2_checkins_id","deprecated":false},{"title":"/rest/v2/checkins/{id}","summary":"Delete a checkin","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/checkins/delete_rest_v2_checkins_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Initiatives","link":"/rest/v2/initiatives","routeSlug":"/rest/v2/initiatives","items":[{"label":"List initiatives","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/initiatives/get_rest_v2_initiatives","routeSlug":"/rest/v2/initiatives/get_rest_v2_initiatives","metadata":{"seo":{"title":"List initiatives","description":"Retrieves all initiatives via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_initiatives","name":"List initiatives","isWebhook":false,"pointer":"/paths/~1rest~1v2~1initiatives/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List initiatives","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":"Retrieves all initiatives via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, discarded_at, type, current_status, uuid, last_checkin_date, time_period_uuid, creator_uuid, archived_at."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"time_period: time_period_uuid, time_period_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners: owners_uuid, owners_display_name, owners_status, owners_manager_uuid, owners_license_type, owners_display_name, owners_status, owners_manager_uuid, owners_license_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"labels: labels_uuid, labels_name, labels_parent_uuid, labels_is_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ancestors: ancestors_uuid, ancestors_discarded_at, ancestors_type, ancestors_current_status, ancestors_uuid, ancestors_last_checkin_date, ancestors_time_period_uuid, ancestors_creator_uuid, ancestors_archived_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams: teams_uuid, teams_display_name, teams_parent_uuid, teams_status, teams_display_name, teams_is_org, teams_parent_uuid, teams_depth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"links_as_child: links_as_child_uuid, links_as_child_ancestor_uuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delegates: delegates_uuid, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1initiatives/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/initiatives","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/initiatives","href":"initiatives/get_rest_v2_initiatives","openApiOperationId":"get_rest_v2_initiatives","summary":"List initiatives"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}},"schemaId":"components/schemas/rest_v2_goal_collection_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1initiatives/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_collection_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/initiatives/get_rest_v2_initiatives"}],"panels":[]}]},"httpPath":"/rest/v2/initiatives"},{"label":"Create a new initiative","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/initiatives/post_rest_v2_initiatives","routeSlug":"/rest/v2/initiatives/post_rest_v2_initiatives","metadata":{"seo":{"title":"Create a new initiative","description":"Creates a new initiative with the provided attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_initiatives","name":"Create a new initiative","isWebhook":false,"pointer":"/paths/~1rest~1v2~1initiatives/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new initiative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new initiative with the provided attributes"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55","pointer":"/paths/~1rest~1v2~1initiatives/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/initiatives","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_55"}},"responseCodes":["201","400","401","403","404","422","429","500"],"pointer":"/rest/v2/initiatives","href":"initiatives/post_rest_v2_initiatives","openApiOperationId":"post_rest_v2_initiatives","summary":"Create a new initiative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"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":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1initiatives/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/initiatives/post_rest_v2_initiatives"}],"panels":[]}]},"httpPath":"/rest/v2/initiatives"},{"label":"Get a specific initiative","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/initiatives/get_rest_v2_initiatives_id","routeSlug":"/rest/v2/initiatives/get_rest_v2_initiatives_id","metadata":{"seo":{"title":"Get a specific initiative","description":"Retrieves detailed information about a specific initiative by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_initiatives_id","name":"Get a specific initiative","isWebhook":false,"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific initiative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific initiative by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Initiative UUID","required":true}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/initiatives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/initiatives/{id}","href":"initiatives/get_rest_v2_initiatives_id","openApiOperationId":"get_rest_v2_initiatives_id","summary":"Get a specific initiative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/initiatives/get_rest_v2_initiatives_id"}],"panels":[]}]},"httpPath":"/rest/v2/initiatives/{id}"},{"label":"Update an initiative","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/initiatives/put_rest_v2_initiatives_id","routeSlug":"/rest/v2/initiatives/put_rest_v2_initiatives_id","metadata":{"seo":{"title":"Update an initiative","description":"Updates an existing initiative with the specified attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_initiatives_id","name":"Update an initiative","isWebhook":false,"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an initiative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing initiative with the specified attributes"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Initiative UUID","required":true}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1rest~1v2~1initiatives~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/initiatives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_56"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/initiatives/{id}","href":"initiatives/put_rest_v2_initiatives_id","openApiOperationId":"put_rest_v2_initiatives_id","summary":"Update an initiative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/initiatives/put_rest_v2_initiatives_id"}],"panels":[]}]},"httpPath":"/rest/v2/initiatives/{id}"},{"label":"Delete an initiative","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/initiatives/delete_rest_v2_initiatives_id","routeSlug":"/rest/v2/initiatives/delete_rest_v2_initiatives_id","metadata":{"seo":{"title":"Delete an initiative","description":"Deletes an initiative and optionally its hierarchy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_initiatives_id","name":"Delete an initiative","isWebhook":false,"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an initiative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an initiative and optionally its hierarchy"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Initiative UUID","required":true}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1rest~1v2~1initiatives~1{id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/initiatives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/initiatives/{id}","href":"initiatives/delete_rest_v2_initiatives_id","openApiOperationId":"delete_rest_v2_initiatives_id","summary":"Delete an initiative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}},"schemaId":"components/schemas/okrs_initiative","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1initiatives~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_initiative","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/initiatives/delete_rest_v2_initiatives_id"}],"panels":[]}]},"httpPath":"/rest/v2/initiatives/{id}"}],"content":{"contentType":"group","meta":{"name":"Initiatives"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiatives","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/initiatives","summary":"List initiatives","prefix":{"name":"get","color":"get"},"badges":[],"link":"/initiatives/get_rest_v2_initiatives","deprecated":false},{"title":"/rest/v2/initiatives","summary":"Create a new initiative","prefix":{"name":"post","color":"post"},"badges":[],"link":"/initiatives/post_rest_v2_initiatives","deprecated":false},{"title":"/rest/v2/initiatives/{id}","summary":"Get a specific initiative","prefix":{"name":"get","color":"get"},"badges":[],"link":"/initiatives/get_rest_v2_initiatives_id","deprecated":false},{"title":"/rest/v2/initiatives/{id}","summary":"Update an initiative","prefix":{"name":"put","color":"put"},"badges":[],"link":"/initiatives/put_rest_v2_initiatives_id","deprecated":false},{"title":"/rest/v2/initiatives/{id}","summary":"Delete an initiative","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/initiatives/delete_rest_v2_initiatives_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Key Results","link":"/rest/v2/key-results","routeSlug":"/rest/v2/key-results","items":[{"label":"List key results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/key-results/get_rest_v2_key_results","routeSlug":"/rest/v2/key-results/get_rest_v2_key_results","metadata":{"seo":{"title":"List key results","description":"Retrieves all key results via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_key_results","name":"List key results","isWebhook":false,"pointer":"/paths/~1rest~1v2~1key_results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List key results","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":"Retrieves all key results via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, discarded_at, type, current_status, uuid, last_checkin_date, time_period_uuid, creator_uuid, archived_at."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"time_period: time_period_uuid, time_period_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners: owners_uuid, owners_display_name, owners_status, owners_manager_uuid, owners_license_type, owners_display_name, owners_status, owners_manager_uuid, owners_license_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"labels: labels_uuid, labels_name, labels_parent_uuid, labels_is_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ancestors: ancestors_uuid, ancestors_discarded_at, ancestors_type, ancestors_current_status, ancestors_uuid, ancestors_last_checkin_date, ancestors_time_period_uuid, ancestors_creator_uuid, ancestors_archived_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams: teams_uuid, teams_display_name, teams_parent_uuid, teams_status, teams_display_name, teams_is_org, teams_parent_uuid, teams_depth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"links_as_child: links_as_child_uuid, links_as_child_ancestor_uuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delegates: delegates_uuid, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1key_results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/key_results","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/key_results","href":"key-results/get_rest_v2_key_results","openApiOperationId":"get_rest_v2_key_results","summary":"List key results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}},"schemaId":"components/schemas/rest_v2_goal_collection_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1key_results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_collection_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/key-results/get_rest_v2_key_results"}],"panels":[]}]},"httpPath":"/rest/v2/key_results"},{"label":"Create a new key result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/key-results/post_rest_v2_key_results","routeSlug":"/rest/v2/key-results/post_rest_v2_key_results","metadata":{"seo":{"title":"Create a new key result","description":"Creates a new key result with the provided attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_key_results","name":"Create a new key result","isWebhook":false,"pointer":"/paths/~1rest~1v2~1key_results/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new key result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new key result with the provided attributes"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55","pointer":"/paths/~1rest~1v2~1key_results/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/key_results","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_55"}},"responseCodes":["201","400","401","403","404","422","429","500"],"pointer":"/rest/v2/key_results","href":"key-results/post_rest_v2_key_results","openApiOperationId":"post_rest_v2_key_results","summary":"Create a new key result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"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":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1key_results/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/key-results/post_rest_v2_key_results"}],"panels":[]}]},"httpPath":"/rest/v2/key_results"},{"label":"Get a specific key result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/key-results/get_rest_v2_key_results_id","routeSlug":"/rest/v2/key-results/get_rest_v2_key_results_id","metadata":{"seo":{"title":"Get a specific key result","description":"Retrieves detailed information about a specific key result by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_key_results_id","name":"Get a specific key result","isWebhook":false,"pointer":"/paths/~1rest~1v2~1key_results~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific key result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific key result by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Key result UUID","required":true}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/key_results/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/key_results/{id}","href":"key-results/get_rest_v2_key_results_id","openApiOperationId":"get_rest_v2_key_results_id","summary":"Get a specific key result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/key-results/get_rest_v2_key_results_id"}],"panels":[]}]},"httpPath":"/rest/v2/key_results/{id}"},{"label":"Update a key result","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/key-results/put_rest_v2_key_results_id","routeSlug":"/rest/v2/key-results/put_rest_v2_key_results_id","metadata":{"seo":{"title":"Update a key result","description":"Updates an existing key result with the specified attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_key_results_id","name":"Update a key result","isWebhook":false,"pointer":"/paths/~1rest~1v2~1key_results~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a key result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing key result with the specified attributes"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Key result UUID","required":true}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1rest~1v2~1key_results~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/key_results/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_56"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/key_results/{id}","href":"key-results/put_rest_v2_key_results_id","openApiOperationId":"put_rest_v2_key_results_id","summary":"Update a key result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/key-results/put_rest_v2_key_results_id"}],"panels":[]}]},"httpPath":"/rest/v2/key_results/{id}"},{"label":"Delete a key result","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/key-results/delete_rest_v2_key_results_id","routeSlug":"/rest/v2/key-results/delete_rest_v2_key_results_id","metadata":{"seo":{"title":"Delete a key result","description":"Deletes a key result and optionally its hierarchy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_key_results_id","name":"Delete a key result","isWebhook":false,"pointer":"/paths/~1rest~1v2~1key_results~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a key result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a key result and optionally its hierarchy"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Key result UUID","required":true}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1rest~1v2~1key_results~1{id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/key_results/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/key_results/{id}","href":"key-results/delete_rest_v2_key_results_id","openApiOperationId":"delete_rest_v2_key_results_id","summary":"Delete a key result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}},"schemaId":"components/schemas/okrs_initiative","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1key_results~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_initiative","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/key-results/delete_rest_v2_key_results_id"}],"panels":[]}]},"httpPath":"/rest/v2/key_results/{id}"}],"content":{"contentType":"group","meta":{"name":"Key Results"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Key Results","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/key_results","summary":"List key results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/key-results/get_rest_v2_key_results","deprecated":false},{"title":"/rest/v2/key_results","summary":"Create a new key result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/key-results/post_rest_v2_key_results","deprecated":false},{"title":"/rest/v2/key_results/{id}","summary":"Get a specific key result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/key-results/get_rest_v2_key_results_id","deprecated":false},{"title":"/rest/v2/key_results/{id}","summary":"Update a key result","prefix":{"name":"put","color":"put"},"badges":[],"link":"/key-results/put_rest_v2_key_results_id","deprecated":false},{"title":"/rest/v2/key_results/{id}","summary":"Delete a key result","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/key-results/delete_rest_v2_key_results_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Labels","link":"/rest/v2/labels","routeSlug":"/rest/v2/labels","items":[{"label":"List labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/labels/get_rest_v2_labels","routeSlug":"/rest/v2/labels/get_rest_v2_labels","metadata":{"seo":{"title":"List labels","description":"Retrieves all labels and label groups via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_labels","name":"List labels","isWebhook":false,"pointer":"/paths/~1rest~1v2~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List labels","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":"Retrieves all labels and label groups via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, name, parent_uuid, is_group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"parent: parent_uuid, parent_name, parent_parent_uuid, parent_is_group"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/labels","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["400","401","403","404","422","429","500"],"pointer":"/rest/v2/labels","href":"labels/get_rest_v2_labels","openApiOperationId":"get_rest_v2_labels","summary":"List labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1labels/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/get_rest_v2_labels"}],"panels":[]}]},"httpPath":"/rest/v2/labels"},{"label":"Create a new label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/labels/post_rest_v2_labels","routeSlug":"/rest/v2/labels/post_rest_v2_labels","metadata":{"seo":{"title":"Create a new label","description":"Creates a new label with the provided attributes. Labels can be regular labels or groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_labels","name":"Create a new label","isWebhook":false,"pointer":"/paths/~1rest~1v2~1labels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new label with the provided attributes. Labels can be regular labels or groups."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58","pointer":"/paths/~1rest~1v2~1labels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/labels","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_58"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/labels","href":"labels/post_rest_v2_labels","openApiOperationId":"post_rest_v2_labels","summary":"Create a new label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_58"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}},"schemaId":"components/schemas/label","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1labels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/post_rest_v2_labels"}],"panels":[]}]},"httpPath":"/rest/v2/labels"},{"label":"Get a specific label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/labels/get_rest_v2_labels_id","routeSlug":"/rest/v2/labels/get_rest_v2_labels_id","metadata":{"seo":{"title":"Get a specific label","description":"Retrieves detailed information about a specific label by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_labels_id","name":"Get a specific label","isWebhook":false,"pointer":"/paths/~1rest~1v2~1labels~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific label by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Label UUID","required":true}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/labels/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/labels/{id}","href":"labels/get_rest_v2_labels_id","openApiOperationId":"get_rest_v2_labels_id","summary":"Get a specific label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}},"schemaId":"components/schemas/label","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/get_rest_v2_labels_id"}],"panels":[]}]},"httpPath":"/rest/v2/labels/{id}"},{"label":"Update a label","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/labels/put_rest_v2_labels_id","routeSlug":"/rest/v2/labels/put_rest_v2_labels_id","metadata":{"seo":{"title":"Update a label","description":"Updates an existing label or label group with the specified attributes. Admins only. Non-group labels can be moved between groups or back to the root by updating parent_uuid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_labels_id","name":"Update a label","isWebhook":false,"pointer":"/paths/~1rest~1v2~1labels~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a label","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":"Updates an existing label or label group with the specified attributes. Admins only. Non-group labels can be moved between groups or back to the root by updating parent_uuid."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Label UUID","required":true}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59","pointer":"/paths/~1rest~1v2~1labels~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/labels/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_59"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/labels/{id}","href":"labels/put_rest_v2_labels_id","openApiOperationId":"put_rest_v2_labels_id","summary":"Update a label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}},"schemaId":"components/schemas/label","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/put_rest_v2_labels_id"}],"panels":[]}]},"httpPath":"/rest/v2/labels/{id}"},{"label":"Delete a label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/labels/delete_rest_v2_labels_id","routeSlug":"/rest/v2/labels/delete_rest_v2_labels_id","metadata":{"seo":{"title":"Delete a label","description":"Deletes a label. If the label has child labels, they will also be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_labels_id","name":"Delete a label","isWebhook":false,"pointer":"/paths/~1rest~1v2~1labels~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a label. If the label has child labels, they will also be deleted."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Label UUID","required":true}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/labels/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/labels/{id}","href":"labels/delete_rest_v2_labels_id","openApiOperationId":"delete_rest_v2_labels_id","summary":"Delete a label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}},"schemaId":"components/schemas/label","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1labels~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/label"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels/delete_rest_v2_labels_id"}],"panels":[]}]},"httpPath":"/rest/v2/labels/{id}"}],"content":{"contentType":"group","meta":{"name":"Labels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Labels","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/labels","summary":"List labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/get_rest_v2_labels","deprecated":false},{"title":"/rest/v2/labels","summary":"Create a new label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels/post_rest_v2_labels","deprecated":false},{"title":"/rest/v2/labels/{id}","summary":"Get a specific label","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/get_rest_v2_labels_id","deprecated":false},{"title":"/rest/v2/labels/{id}","summary":"Update a label","prefix":{"name":"put","color":"put"},"badges":[],"link":"/labels/put_rest_v2_labels_id","deprecated":false},{"title":"/rest/v2/labels/{id}","summary":"Delete a label","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/labels/delete_rest_v2_labels_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Objectives","link":"/rest/v2/objectives","routeSlug":"/rest/v2/objectives","items":[{"label":"List objectives","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/objectives/get_rest_v2_objectives","routeSlug":"/rest/v2/objectives/get_rest_v2_objectives","metadata":{"seo":{"title":"List objectives","description":"Retrieves all objectives via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_objectives","name":"List objectives","isWebhook":false,"pointer":"/paths/~1rest~1v2~1objectives/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List objectives","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":"Retrieves all objectives via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, discarded_at, type, current_status, uuid, last_checkin_date, time_period_uuid, creator_uuid, archived_at."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"time_period: time_period_uuid, time_period_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners: owners_uuid, owners_display_name, owners_status, owners_manager_uuid, owners_license_type, owners_display_name, owners_status, owners_manager_uuid, owners_license_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"labels: labels_uuid, labels_name, labels_parent_uuid, labels_is_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ancestors: ancestors_uuid, ancestors_discarded_at, ancestors_type, ancestors_current_status, ancestors_uuid, ancestors_last_checkin_date, ancestors_time_period_uuid, ancestors_creator_uuid, ancestors_archived_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams: teams_uuid, teams_display_name, teams_parent_uuid, teams_status, teams_display_name, teams_is_org, teams_parent_uuid, teams_depth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"links_as_child: links_as_child_uuid, links_as_child_ancestor_uuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delegates: delegates_uuid, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type, delegates_display_name, delegates_status, delegates_manager_uuid, delegates_license_type"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1objectives/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/objectives","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/objectives","href":"objectives/get_rest_v2_objectives","openApiOperationId":"get_rest_v2_objectives","summary":"List objectives"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}},"schemaId":"components/schemas/rest_v2_goal_collection_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1objectives/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_collection_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_collection_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/objectives/get_rest_v2_objectives"}],"panels":[]}]},"httpPath":"/rest/v2/objectives"},{"label":"Create a new objective","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/objectives/post_rest_v2_objectives","routeSlug":"/rest/v2/objectives/post_rest_v2_objectives","metadata":{"seo":{"title":"Create a new objective","description":"Creates a new objective with the provided attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_objectives","name":"Create a new objective","isWebhook":false,"pointer":"/paths/~1rest~1v2~1objectives/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new objective","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new objective with the provided attributes"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55","pointer":"/paths/~1rest~1v2~1objectives/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/objectives","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_55"}},"responseCodes":["201","400","401","403","404","422","429","500"],"pointer":"/rest/v2/objectives","href":"objectives/post_rest_v2_objectives","openApiOperationId":"post_rest_v2_objectives","summary":"Create a new objective"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"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":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1objectives/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/objectives/post_rest_v2_objectives"}],"panels":[]}]},"httpPath":"/rest/v2/objectives"},{"label":"Get a specific objective","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/objectives/get_rest_v2_objectives_id","routeSlug":"/rest/v2/objectives/get_rest_v2_objectives_id","metadata":{"seo":{"title":"Get a specific objective","description":"Retrieves detailed information about a specific objective by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_objectives_id","name":"Get a specific objective","isWebhook":false,"pointer":"/paths/~1rest~1v2~1objectives~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific objective","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific objective by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Objective UUID","required":true}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/objectives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/objectives/{id}","href":"objectives/get_rest_v2_objectives_id","openApiOperationId":"get_rest_v2_objectives_id","summary":"Get a specific objective"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/objectives/get_rest_v2_objectives_id"}],"panels":[]}]},"httpPath":"/rest/v2/objectives/{id}"},{"label":"Update an objective","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/objectives/put_rest_v2_objectives_id","routeSlug":"/rest/v2/objectives/put_rest_v2_objectives_id","metadata":{"seo":{"title":"Update an objective","description":"Updates an existing objective with the specified attributes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_objectives_id","name":"Update an objective","isWebhook":false,"pointer":"/paths/~1rest~1v2~1objectives~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an objective","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing objective with the specified attributes"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Objective UUID","required":true}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1rest~1v2~1objectives~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/objectives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_56"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/objectives/{id}","href":"objectives/put_rest_v2_objectives_id","openApiOperationId":"put_rest_v2_objectives_id","summary":"Update an objective"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}},"schemaId":"components/schemas/rest_v2_goal_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_goal_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_goal_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/objectives/put_rest_v2_objectives_id"}],"panels":[]}]},"httpPath":"/rest/v2/objectives/{id}"},{"label":"Delete an objective","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/objectives/delete_rest_v2_objectives_id","routeSlug":"/rest/v2/objectives/delete_rest_v2_objectives_id","metadata":{"seo":{"title":"Delete an objective","description":"Deletes an objective and optionally its hierarchy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_objectives_id","name":"Delete an objective","isWebhook":false,"pointer":"/paths/~1rest~1v2~1objectives~1{id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an objective","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an objective and optionally its hierarchy"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Objective UUID","required":true}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1rest~1v2~1objectives~1{id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/objectives/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/objectives/{id}","href":"objectives/delete_rest_v2_objectives_id","openApiOperationId":"delete_rest_v2_objectives_id","summary":"Delete an objective"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}},"schemaId":"components/schemas/okrs_initiative","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1objectives~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/okrs_initiative","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/okrs_initiative"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/objectives/delete_rest_v2_objectives_id"}],"panels":[]}]},"httpPath":"/rest/v2/objectives/{id}"}],"content":{"contentType":"group","meta":{"name":"Objectives"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Objectives","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/objectives","summary":"List objectives","prefix":{"name":"get","color":"get"},"badges":[],"link":"/objectives/get_rest_v2_objectives","deprecated":false},{"title":"/rest/v2/objectives","summary":"Create a new objective","prefix":{"name":"post","color":"post"},"badges":[],"link":"/objectives/post_rest_v2_objectives","deprecated":false},{"title":"/rest/v2/objectives/{id}","summary":"Get a specific objective","prefix":{"name":"get","color":"get"},"badges":[],"link":"/objectives/get_rest_v2_objectives_id","deprecated":false},{"title":"/rest/v2/objectives/{id}","summary":"Update an objective","prefix":{"name":"put","color":"put"},"badges":[],"link":"/objectives/put_rest_v2_objectives_id","deprecated":false},{"title":"/rest/v2/objectives/{id}","summary":"Delete an objective","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/objectives/delete_rest_v2_objectives_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/rest/v2/teams","routeSlug":"/rest/v2/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/teams/get_rest_v2_teams","routeSlug":"/rest/v2/teams/get_rest_v2_teams","metadata":{"seo":{"title":"List teams","description":"Retrieves all teams via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_teams","name":"List teams","isWebhook":false,"pointer":"/paths/~1rest~1v2~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List teams","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":"Retrieves all teams via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, display_name, parent_uuid, status, display_name, is_org, parent_uuid, depth."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"team_memberships: team_memberships_uuid, team_memberships_user_uuid"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/teams","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["400","401","403","404","422","429","500"],"pointer":"/rest/v2/teams","href":"teams/get_rest_v2_teams","openApiOperationId":"get_rest_v2_teams","summary":"List teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1teams/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/get_rest_v2_teams"}],"panels":[]}]},"httpPath":"/rest/v2/teams"},{"label":"Create a new team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/teams/post_rest_v2_teams","routeSlug":"/rest/v2/teams/post_rest_v2_teams","metadata":{"seo":{"title":"Create a new team","description":"Creates a new team with the specified attributes, owners, and members"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_teams","name":"Create a new team","isWebhook":false,"pointer":"/paths/~1rest~1v2~1teams/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new team with the specified attributes, owners, and members"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60","pointer":"/paths/~1rest~1v2~1teams/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/teams","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_60"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/teams","href":"teams/post_rest_v2_teams","openApiOperationId":"post_rest_v2_teams","summary":"Create a new team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}},"schemaId":"components/schemas/team","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1teams/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/post_rest_v2_teams"}],"panels":[]}]},"httpPath":"/rest/v2/teams"},{"label":"Get a specific team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/teams/get_rest_v2_teams_id","routeSlug":"/rest/v2/teams/get_rest_v2_teams_id","metadata":{"seo":{"title":"Get a specific team","description":"Retrieves detailed information about a specific team by its UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_teams_id","name":"Get a specific team","isWebhook":false,"pointer":"/paths/~1rest~1v2~1teams~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific team by its UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Team UUID","required":true}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/teams/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/teams/{id}","href":"teams/get_rest_v2_teams_id","openApiOperationId":"get_rest_v2_teams_id","summary":"Get a specific team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}},"schemaId":"components/schemas/team","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/get_rest_v2_teams_id"}],"panels":[]}]},"httpPath":"/rest/v2/teams/{id}"},{"label":"Update a team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/teams/put_rest_v2_teams_id","routeSlug":"/rest/v2/teams/put_rest_v2_teams_id","metadata":{"seo":{"title":"Update a team","description":"Updates an existing team with the specified attributes, owners, and members"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_teams_id","name":"Update a team","isWebhook":false,"pointer":"/paths/~1rest~1v2~1teams~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing team with the specified attributes, owners, and members"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Team UUID","required":true}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61","pointer":"/paths/~1rest~1v2~1teams~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/teams/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_61"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/teams/{id}","href":"teams/put_rest_v2_teams_id","openApiOperationId":"put_rest_v2_teams_id","summary":"Update a team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}},"schemaId":"components/schemas/team","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/put_rest_v2_teams_id"}],"panels":[]}]},"httpPath":"/rest/v2/teams/{id}"},{"label":"Delete a team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/teams/delete_rest_v2_teams_id","routeSlug":"/rest/v2/teams/delete_rest_v2_teams_id","metadata":{"seo":{"title":"Delete a team","description":"Deletes a team if it has no active sub-teams or OKR relationships"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_rest_v2_teams_id","name":"Delete a team","isWebhook":false,"pointer":"/paths/~1rest~1v2~1teams~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a team if it has no active sub-teams or OKR relationships"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"Team UUID","required":true}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rest/v2/teams/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/teams/{id}","href":"teams/delete_rest_v2_teams_id","openApiOperationId":"delete_rest_v2_teams_id","summary":"Delete a team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}},"schemaId":"components/schemas/team","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1teams~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/team"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/delete_rest_v2_teams_id"}],"panels":[]}]},"httpPath":"/rest/v2/teams/{id}"}],"content":{"contentType":"group","meta":{"name":"Teams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/teams","summary":"List teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/get_rest_v2_teams","deprecated":false},{"title":"/rest/v2/teams","summary":"Create a new team","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams/post_rest_v2_teams","deprecated":false},{"title":"/rest/v2/teams/{id}","summary":"Get a specific team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/get_rest_v2_teams_id","deprecated":false},{"title":"/rest/v2/teams/{id}","summary":"Update a team","prefix":{"name":"put","color":"put"},"badges":[],"link":"/teams/put_rest_v2_teams_id","deprecated":false},{"title":"/rest/v2/teams/{id}","summary":"Delete a team","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/teams/delete_rest_v2_teams_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/rest/v2/users","routeSlug":"/rest/v2/users","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/users/get_rest_v2_users","routeSlug":"/rest/v2/users/get_rest_v2_users","metadata":{"seo":{"title":"List users","description":"Retrieves all users via REST API"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_users","name":"List users","isWebhook":false,"pointer":"/paths/~1rest~1v2~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","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":"Retrieves all users via REST API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, display_name, status, manager_uuid, license_type, display_name, status, manager_uuid, license_type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available ransackable associations and their attributes:"},"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":"direct_teams: direct_teams_uuid, direct_teams_display_name, direct_teams_parent_uuid, direct_teams_status, direct_teams_display_name, direct_teams_is_org, direct_teams_parent_uuid, direct_teams_depth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team_memberships: team_memberships_uuid, team_memberships_user_uuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"profile: profile_uuid, profile_first_name, profile_last_name, profile_job_title, profile_employee_type, profile_department_name, profile_division_name, profile_cost_center_name, profile_about, profile_custom_field_1, profile_custom_field_2, profile_custom_field_3, profile_custom_field_4, profile_custom_field_5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manager: manager_uuid, manager_display_name, manager_status, manager_manager_uuid, manager_license_type, manager_display_name, manager_status, manager_manager_uuid, manager_license_type"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_48","description":"Page number for pagination (default: 1)"},{"name":"per_page","in":"query","schemaId":"schema_49","description":"Number of records per page (default: 20, max: 100)"},{"name":"limit","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for per_page - number of records per page"},"children":[]}]}]}]},{"name":"limit_max","in":"query","schemaId":"schema_50","description":"Maximum number of records per page (overrides limit if not set)"},{"name":"offset","in":"query","schemaId":"schema_51","description":"Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset."},{"name":"count","in":"query","schemaId":"schema_52","description":"Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages."}],"pointer":"/paths/~1rest~1v2~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/users","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_48"},{"name":"per_page","in":"query","schemaId":"schema_49"},{"name":"limit","in":"query","schemaId":"schema_49"},{"name":"limit_max","in":"query","schemaId":"schema_50"},{"name":"offset","in":"query","schemaId":"schema_51"},{"name":"count","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/users","href":"users/get_rest_v2_users","openApiOperationId":"get_rest_v2_users","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_collection_response"}},"schemaId":"components/schemas/rest_v2_user_collection_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_user_collection_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_collection_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get_rest_v2_users"}],"panels":[]}]},"httpPath":"/rest/v2/users"},{"label":"Create a new user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/users/post_rest_v2_users","routeSlug":"/rest/v2/users/post_rest_v2_users","metadata":{"seo":{"title":"Create a new user","description":"Creates a new user with the provided attributes. Email is required and must be unique within the tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post_rest_v2_users","name":"Create a new user","isWebhook":false,"pointer":"/paths/~1rest~1v2~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new user with the provided attributes. Email is required and must be unique within the tenant."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62","pointer":"/paths/~1rest~1v2~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rest/v2/users","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_62"}},"responseCodes":["201","400","401","403","404","422","429","500"],"pointer":"/rest/v2/users","href":"users/post_rest_v2_users","openApiOperationId":"post_rest_v2_users","summary":"Create a new user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"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":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}},"schemaId":"components/schemas/rest_v2_user_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/rest_v2_user_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/post_rest_v2_users"}],"panels":[]}]},"httpPath":"/rest/v2/users"},{"label":"Get a specific user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/users/get_rest_v2_users_id","routeSlug":"/rest/v2/users/get_rest_v2_users_id","metadata":{"seo":{"title":"Get a specific user","description":"Retrieves detailed information about a specific user by their UUID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_rest_v2_users_id","name":"Get a specific user","isWebhook":false,"pointer":"/paths/~1rest~1v2~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information about a specific user by their UUID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"User UUID","required":true}],"pointer":"/paths/~1rest~1v2~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rest/v2/users/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/users/{id}","href":"users/get_rest_v2_users_id","openApiOperationId":"get_rest_v2_users_id","summary":"Get a specific user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}},"schemaId":"components/schemas/rest_v2_user_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_user_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/get_rest_v2_users_id"}],"panels":[]}]},"httpPath":"/rest/v2/users/{id}"},{"label":"Update a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/v2/users/put_rest_v2_users_id","routeSlug":"/rest/v2/users/put_rest_v2_users_id","metadata":{"seo":{"title":"Update a user","description":"Updates an existing user with the specified attributes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put_rest_v2_users_id","name":"Update a user","isWebhook":false,"pointer":"/paths/~1rest~1v2~1users~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing user with the specified attributes."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_52","description":"User UUID","required":true}],"pointer":"/paths/~1rest~1v2~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_63"}},"schemaId":"schema_63","pointer":"/paths/~1rest~1v2~1users~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rest/v2/users/{id}","servers":[{"url":"https://api.rhythms.ai"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_52"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_63"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/rest/v2/users/{id}","href":"users/put_rest_v2_users_id","openApiOperationId":"put_rest_v2_users_id","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.rhythms.ai"}],"schemaId":"schema_63","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_63"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}},"schemaId":"components/schemas/rest_v2_user_response","headers":{}},{"code":"400","description":"Bad Request - Invalid parameters or malformed request"},{"code":"401","description":"Unauthorized - Invalid or missing authentication"},{"code":"403","description":"Forbidden - User lacks permission to access this resource"},{"code":"404","description":"Not Found - Resource does not exist"},{"code":"422","description":"Unprocessable Entity - Invalid request parameters or validation errors"},{"code":"429","description":"Too Many Requests - Rate limit exceeded"},{"code":"500","description":"Internal Server Error - Unexpected server error"}],"pointer":"/paths/~1rest~1v2~1users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rest_v2_user_response","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/rest_v2_user_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/put_rest_v2_users_id"}],"panels":[]}]},"httpPath":"/rest/v2/users/{id}"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rest/v2/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get_rest_v2_users","deprecated":false},{"title":"/rest/v2/users","summary":"Create a new user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/post_rest_v2_users","deprecated":false},{"title":"/rest/v2/users/{id}","summary":"Get a specific user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/get_rest_v2_users_id","deprecated":false},{"title":"/rest/v2/users/{id}","summary":"Update a user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/put_rest_v2_users_id","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/okrs_checkin":{"id":"components/schemas/okrs_checkin","kind":"json-schema","title":"okrs_checkin","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"goal_uuid":{"type":"string","description":"Goal uuid"},"metric_uuid":{"type":"string","default":null,"description":"Metric uuid"},"value":{"type":"number","default":null,"description":"Value"},"progress":{"type":"number","default":null,"description":"Progress"},"score":{"type":"number","default":null,"description":"Score"},"checkin_date":{"type":"string","description":"Checkin date"},"status":{"type":"string","default":"not_started","description":"Status"},"note":{"type":"string","default":null,"description":"Note"},"creator_uuid":{"type":"string","description":"Creator uuid"},"source_info":{"type":"object","additionalProperties":true,"default":"{}","description":"Source info"},"mentioned_entities":{"type":"object","additionalProperties":true,"default":"[]","description":"Mentioned entities"}},"additionalProperties":false,"required":["uuid","goal_uuid","checkin_date","creator_uuid","source_info","mentioned_entities"]}},"components/schemas/rest_v2_goal_collection_response":{"id":"components/schemas/rest_v2_goal_collection_response","kind":"json-schema","title":"rest_v2_goal_collection_response","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","default":null,"description":"Record type"},"records":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"type":{"type":"string","description":"Type"},"title":{"type":"string","description":"Title"},"description":{"type":"string","default":null,"description":"Description"},"start_date":{"type":"string","description":"Start date"},"end_date":{"type":"string","description":"End date"},"goal_type":{"type":"string","default":"aspirational","description":"Goal type"},"time_period_uuid":{"type":"string","description":"Time period uuid"},"current_metric_uuid":{"type":"string","default":null,"description":"Current metric uuid"},"creator_uuid":{"type":"string","description":"Creator uuid"},"last_checkin_date":{"type":"string","default":null,"description":"Last checkin date"},"score":{"type":"number","default":null,"description":"Score"},"current_progress":{"type":"number","default":null,"description":"Current progress"},"current_value":{"type":"number","default":null,"description":"Current value"},"current_status":{"type":"string","default":"not_started","description":"Current status"},"source_uuid":{"type":"string","default":null,"description":"Source uuid"},"source_type":{"type":"string","default":null,"description":"Source type"},"path":{"type":"string","default":null,"description":"Path"},"searchable_content":{"type":"string","default":null,"description":"Searchable content"},"progress_mode":{"type":"string","default":"manual","description":"Progress mode"},"value_updated_at":{"type":"string","default":null,"description":"Value updated at"},"status_updated_at":{"type":"string","default":null,"description":"Status updated at"},"value_updated_by_uuid":{"type":"string","default":null,"description":"Value updated by uuid"},"status_updated_by_uuid":{"type":"string","default":null,"description":"Status updated by uuid"},"visibility":{"type":"string","default":"public","description":"Visibility"},"ai_rollup_enabled":{"type":"boolean","default":false,"description":"Ai rollup enabled"},"data_sources_count":{"type":"number","default":0,"description":"Data sources count"},"discarded_at":{"type":"string","default":null,"description":"Discarded at"},"discarded_by_uuid":{"type":"string","default":null,"description":"Discarded by uuid"},"short_id_uuid":{"type":"string","default":null,"description":"Short id uuid"},"archived_at":{"type":"string","default":null,"description":"Archived at"},"archived_by_uuid":{"type":"string","default":null,"description":"Archived by uuid"},"short_id":{"type":"string","description":"Human-readable goal identifier"},"owner_uuids":{"items":{"type":"string"},"type":"array","description":"UUIDs of the goal owners"},"target":{"type":"number","default":null,"description":"Current metric target"},"unit":{"type":"string","default":null,"description":"Current metric unit"},"metric_type":{"type":"string","default":null,"description":"Current metric type"},"parent_links":{"type":"array","items":{"type":"object","properties":{"parent_uuid":{"type":"string","description":"Parent goal UUID"},"contribution_percent":{"type":"number","description":"Contribution weight toward the parent"}},"additionalProperties":false,"required":["parent_uuid","contribution_percent"]}},"visible_entities":{"type":"array","items":{"type":"object","properties":{"entity_type":{"type":"string","enum":["User","Team"],"description":"Whether the goal is scoped to a user or a team"},"entity_uuid":{"type":"string","description":"UUID of the user or team"},"mode":{"type":"string","enum":["direct","own","create","inherit"],"description":"How the entity was granted visibility: direct is an explicit selection, own is an owner or delegate or a team the goal is assigned to, create is the creator, inherit is inherited from elsewhere"}},"additionalProperties":false,"required":["entity_type","entity_uuid","mode"]}}},"additionalProperties":false,"required":["uuid","type","title","start_date","end_date","goal_type","time_period_uuid","creator_uuid","current_status","progress_mode","visibility","ai_rollup_enabled","data_sources_count","short_id","owner_uuids","parent_links","visible_entities"]}},"pagy":{"type":"object","additionalProperties":true,"default":null,"description":"Pagination metadata"},"checks":{"type":"object","additionalProperties":true,"default":null,"description":"Policy checks keyed by record UUID"},"filters":{"type":"object","additionalProperties":true,"default":null,"description":"Applied filters"}},"additionalProperties":false,"required":["records"]}},"additionalProperties":false,"required":["data"]}},"components/schemas/rest_v2_goal_response":{"id":"components/schemas/rest_v2_goal_response","kind":"json-schema","title":"rest_v2_goal_response","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","description":"Record type"},"record":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"type":{"type":"string","description":"Type"},"title":{"type":"string","description":"Title"},"description":{"type":"string","default":null,"description":"Description"},"start_date":{"type":"string","description":"Start date"},"end_date":{"type":"string","description":"End date"},"goal_type":{"type":"string","default":"aspirational","description":"Goal type"},"time_period_uuid":{"type":"string","description":"Time period uuid"},"current_metric_uuid":{"type":"string","default":null,"description":"Current metric uuid"},"creator_uuid":{"type":"string","description":"Creator uuid"},"last_checkin_date":{"type":"string","default":null,"description":"Last checkin date"},"score":{"type":"number","default":null,"description":"Score"},"current_progress":{"type":"number","default":null,"description":"Current progress"},"current_value":{"type":"number","default":null,"description":"Current value"},"current_status":{"type":"string","default":"not_started","description":"Current status"},"source_uuid":{"type":"string","default":null,"description":"Source uuid"},"source_type":{"type":"string","default":null,"description":"Source type"},"path":{"type":"string","default":null,"description":"Path"},"searchable_content":{"type":"string","default":null,"description":"Searchable content"},"progress_mode":{"type":"string","default":"manual","description":"Progress mode"},"value_updated_at":{"type":"string","default":null,"description":"Value updated at"},"status_updated_at":{"type":"string","default":null,"description":"Status updated at"},"value_updated_by_uuid":{"type":"string","default":null,"description":"Value updated by uuid"},"status_updated_by_uuid":{"type":"string","default":null,"description":"Status updated by uuid"},"visibility":{"type":"string","default":"public","description":"Visibility"},"ai_rollup_enabled":{"type":"boolean","default":false,"description":"Ai rollup enabled"},"data_sources_count":{"type":"number","default":0,"description":"Data sources count"},"discarded_at":{"type":"string","default":null,"description":"Discarded at"},"discarded_by_uuid":{"type":"string","default":null,"description":"Discarded by uuid"},"short_id_uuid":{"type":"string","default":null,"description":"Short id uuid"},"archived_at":{"type":"string","default":null,"description":"Archived at"},"archived_by_uuid":{"type":"string","default":null,"description":"Archived by uuid"},"short_id":{"type":"string","description":"Human-readable goal identifier"},"owner_uuids":{"items":{"type":"string"},"type":"array","description":"UUIDs of the goal owners"},"target":{"type":"number","default":null,"description":"Current metric target"},"unit":{"type":"string","default":null,"description":"Current metric unit"},"metric_type":{"type":"string","default":null,"description":"Current metric type"},"parent_links":{"type":"array","items":{"type":"object","properties":{"parent_uuid":{"type":"string","description":"Parent goal UUID"},"contribution_percent":{"type":"number","description":"Contribution weight toward the parent"}},"additionalProperties":false,"required":["parent_uuid","contribution_percent"]}},"visible_entities":{"type":"array","items":{"type":"object","properties":{"entity_type":{"type":"string","enum":["User","Team"],"description":"Whether the goal is scoped to a user or a team"},"entity_uuid":{"type":"string","description":"UUID of the user or team"},"mode":{"type":"string","enum":["direct","own","create","inherit"],"description":"How the entity was granted visibility: direct is an explicit selection, own is an owner or delegate or a team the goal is assigned to, create is the creator, inherit is inherited from elsewhere"}},"additionalProperties":false,"required":["entity_type","entity_uuid","mode"]}}},"additionalProperties":false,"required":["uuid","type","title","start_date","end_date","goal_type","time_period_uuid","creator_uuid","current_status","progress_mode","visibility","ai_rollup_enabled","data_sources_count","short_id","owner_uuids","parent_links","visible_entities"]},"checks":{"type":"object","additionalProperties":true,"default":null,"description":"Policy checks for the record"},"access_source":{"type":"object","additionalProperties":true,"default":null,"description":"How the caller can access the record"}},"additionalProperties":false,"required":["type","record"]}},"additionalProperties":false,"required":["data"]}},"components/schemas/okrs_initiative":{"id":"components/schemas/okrs_initiative","kind":"json-schema","title":"okrs_initiative","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"type":{"type":"string","description":"Type"},"title":{"type":"string","description":"Title"},"description":{"type":"string","default":null,"description":"Description"},"start_date":{"type":"string","description":"Start date"},"end_date":{"type":"string","description":"End date"},"goal_type":{"type":"string","default":"aspirational","description":"Goal type"},"time_period_uuid":{"type":"string","description":"Time period uuid"},"current_metric_uuid":{"type":"string","default":null,"description":"Current metric uuid"},"creator_uuid":{"type":"string","description":"Creator uuid"},"last_checkin_date":{"type":"string","default":null,"description":"Last checkin date"},"score":{"type":"number","default":null,"description":"Score"},"current_progress":{"type":"number","default":null,"description":"Current progress"},"current_value":{"type":"number","default":null,"description":"Current value"},"current_status":{"type":"string","default":"not_started","description":"Current status"},"source_uuid":{"type":"string","default":null,"description":"Source uuid"},"source_type":{"type":"string","default":null,"description":"Source type"},"path":{"type":"string","default":null,"description":"Path"},"searchable_content":{"type":"string","default":null,"description":"Searchable content"},"progress_mode":{"type":"string","default":"manual","description":"Progress mode"},"value_updated_at":{"type":"string","default":null,"description":"Value updated at"},"status_updated_at":{"type":"string","default":null,"description":"Status updated at"},"value_updated_by_uuid":{"type":"string","default":null,"description":"Value updated by uuid"},"status_updated_by_uuid":{"type":"string","default":null,"description":"Status updated by uuid"},"visibility":{"type":"string","default":"public","description":"Visibility"},"ai_rollup_enabled":{"type":"boolean","default":false,"description":"Ai rollup enabled"},"data_sources_count":{"type":"number","default":0,"description":"Data sources count"},"discarded_at":{"type":"string","default":null,"description":"Discarded at"},"discarded_by_uuid":{"type":"string","default":null,"description":"Discarded by uuid"},"short_id_uuid":{"type":"string","default":null,"description":"Short id uuid"},"archived_at":{"type":"string","default":null,"description":"Archived at"},"archived_by_uuid":{"type":"string","default":null,"description":"Archived by uuid"}},"additionalProperties":false,"required":["uuid","type","title","start_date","end_date","goal_type","time_period_uuid","creator_uuid","current_status","progress_mode","visibility","ai_rollup_enabled","data_sources_count"]}},"components/schemas/okrs_key_result":{"id":"components/schemas/okrs_key_result","kind":"json-schema","title":"okrs_key_result","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"type":{"type":"string","description":"Type"},"title":{"type":"string","description":"Title"},"description":{"type":"string","default":null,"description":"Description"},"start_date":{"type":"string","description":"Start date"},"end_date":{"type":"string","description":"End date"},"goal_type":{"type":"string","default":"aspirational","description":"Goal type"},"time_period_uuid":{"type":"string","description":"Time period uuid"},"current_metric_uuid":{"type":"string","default":null,"description":"Current metric uuid"},"creator_uuid":{"type":"string","description":"Creator uuid"},"last_checkin_date":{"type":"string","default":null,"description":"Last checkin date"},"score":{"type":"number","default":null,"description":"Score"},"current_progress":{"type":"number","default":null,"description":"Current progress"},"current_value":{"type":"number","default":null,"description":"Current value"},"current_status":{"type":"string","default":"not_started","description":"Current status"},"source_uuid":{"type":"string","default":null,"description":"Source uuid"},"source_type":{"type":"string","default":null,"description":"Source type"},"path":{"type":"string","default":null,"description":"Path"},"searchable_content":{"type":"string","default":null,"description":"Searchable content"},"progress_mode":{"type":"string","default":"manual","description":"Progress mode"},"value_updated_at":{"type":"string","default":null,"description":"Value updated at"},"status_updated_at":{"type":"string","default":null,"description":"Status updated at"},"value_updated_by_uuid":{"type":"string","default":null,"description":"Value updated by uuid"},"status_updated_by_uuid":{"type":"string","default":null,"description":"Status updated by uuid"},"visibility":{"type":"string","default":"public","description":"Visibility"},"ai_rollup_enabled":{"type":"boolean","default":false,"description":"Ai rollup enabled"},"data_sources_count":{"type":"number","default":0,"description":"Data sources count"},"discarded_at":{"type":"string","default":null,"description":"Discarded at"},"discarded_by_uuid":{"type":"string","default":null,"description":"Discarded by uuid"},"short_id_uuid":{"type":"string","default":null,"description":"Short id uuid"},"archived_at":{"type":"string","default":null,"description":"Archived at"},"archived_by_uuid":{"type":"string","default":null,"description":"Archived by uuid"}},"additionalProperties":false,"required":["uuid","type","title","start_date","end_date","goal_type","time_period_uuid","creator_uuid","current_status","progress_mode","visibility","ai_rollup_enabled","data_sources_count"]}},"components/schemas/label":{"id":"components/schemas/label","kind":"json-schema","title":"label","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"name":{"type":"string","description":"Name"},"is_group":{"type":"boolean","default":false,"description":"Is group"},"parent_uuid":{"type":"string","default":null,"description":"Parent uuid"},"labelings_count":{"type":"number","default":0,"description":"Labelings count"},"description":{"type":"string","default":null,"description":"Description"},"creator_uuid":{"type":"string","default":null,"description":"Creator uuid"},"color":{"type":"string","default":null,"description":"Color"}},"additionalProperties":false,"required":["uuid","name","is_group","labelings_count"]}},"components/schemas/okrs_objective":{"id":"components/schemas/okrs_objective","kind":"json-schema","title":"okrs_objective","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"type":{"type":"string","description":"Type"},"title":{"type":"string","description":"Title"},"description":{"type":"string","default":null,"description":"Description"},"start_date":{"type":"string","description":"Start date"},"end_date":{"type":"string","description":"End date"},"goal_type":{"type":"string","default":"aspirational","description":"Goal type"},"time_period_uuid":{"type":"string","description":"Time period uuid"},"current_metric_uuid":{"type":"string","default":null,"description":"Current metric uuid"},"creator_uuid":{"type":"string","description":"Creator uuid"},"last_checkin_date":{"type":"string","default":null,"description":"Last checkin date"},"score":{"type":"number","default":null,"description":"Score"},"current_progress":{"type":"number","default":null,"description":"Current progress"},"current_value":{"type":"number","default":null,"description":"Current value"},"current_status":{"type":"string","default":"not_started","description":"Current status"},"source_uuid":{"type":"string","default":null,"description":"Source uuid"},"source_type":{"type":"string","default":null,"description":"Source type"},"path":{"type":"string","default":null,"description":"Path"},"searchable_content":{"type":"string","default":null,"description":"Searchable content"},"progress_mode":{"type":"string","default":"manual","description":"Progress mode"},"value_updated_at":{"type":"string","default":null,"description":"Value updated at"},"status_updated_at":{"type":"string","default":null,"description":"Status updated at"},"value_updated_by_uuid":{"type":"string","default":null,"description":"Value updated by uuid"},"status_updated_by_uuid":{"type":"string","default":null,"description":"Status updated by uuid"},"visibility":{"type":"string","default":"public","description":"Visibility"},"ai_rollup_enabled":{"type":"boolean","default":false,"description":"Ai rollup enabled"},"data_sources_count":{"type":"number","default":0,"description":"Data sources count"},"discarded_at":{"type":"string","default":null,"description":"Discarded at"},"discarded_by_uuid":{"type":"string","default":null,"description":"Discarded by uuid"},"short_id_uuid":{"type":"string","default":null,"description":"Short id uuid"},"archived_at":{"type":"string","default":null,"description":"Archived at"},"archived_by_uuid":{"type":"string","default":null,"description":"Archived by uuid"}},"additionalProperties":false,"required":["uuid","type","title","start_date","end_date","goal_type","time_period_uuid","creator_uuid","current_status","progress_mode","visibility","ai_rollup_enabled","data_sources_count"]}},"components/schemas/team":{"id":"components/schemas/team","kind":"json-schema","title":"team","data":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"parent_uuid":{"type":"string","default":null,"description":"Parent uuid"},"display_name":{"type":"string","description":"Display name"},"is_org":{"type":"boolean","default":false,"description":"Is org"},"description":{"type":"string","default":null,"description":"Description"},"path":{"type":"string","default":null,"description":"Path"},"status":{"type":"string","default":"active","description":"Status"},"depth":{"type":"number","default":0,"description":"Depth"},"viva_goals_team_id":{"type":"string","default":null,"description":"Viva goals team"},"icon":{"type":"string","default":null,"description":"Icon"},"color":{"type":"string","default":null,"description":"Color"}},"additionalProperties":false,"required":["uuid","display_name","is_org","status"]}},"components/schemas/rest_v2_user_collection_response":{"id":"components/schemas/rest_v2_user_collection_response","kind":"json-schema","title":"rest_v2_user_collection_response","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","default":null,"description":"Record type"},"records":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"display_name":{"type":"string","description":"Display name"},"account_id":{"type":"string","default":null,"description":"Account"},"status":{"type":"string","default":"active","description":"Status"},"manager_uuid":{"type":"string","default":null,"description":"Manager uuid"},"path":{"type":"string","default":null,"description":"Path"},"creator_uuid":{"type":"string","default":null,"description":"Creator uuid"},"license_type":{"type":"string","description":"License type"},"display_name_source":{"type":"string","default":"manual","description":"Display name source"},"avatar_url":{"type":"string","default":null,"description":"User avatar URL"},"external_employee_id":{"type":"string","default":null,"description":"External directory employee identifier"}},"additionalProperties":false,"required":["uuid","display_name","status","license_type","display_name_source"]}},"pagy":{"type":"object","additionalProperties":true,"default":null,"description":"Pagination metadata"},"checks":{"type":"object","additionalProperties":true,"default":null,"description":"Policy checks keyed by record UUID"},"filters":{"type":"object","additionalProperties":true,"default":null,"description":"Applied filters"}},"additionalProperties":false,"required":["records"]}},"additionalProperties":false,"required":["data"]}},"components/schemas/rest_v2_user_response":{"id":"components/schemas/rest_v2_user_response","kind":"json-schema","title":"rest_v2_user_response","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","description":"Record type"},"record":{"type":"object","properties":{"uuid":{"type":"string","description":"Uuid"},"display_name":{"type":"string","description":"Display name"},"account_id":{"type":"string","default":null,"description":"Account"},"status":{"type":"string","default":"active","description":"Status"},"manager_uuid":{"type":"string","default":null,"description":"Manager uuid"},"path":{"type":"string","default":null,"description":"Path"},"creator_uuid":{"type":"string","default":null,"description":"Creator uuid"},"license_type":{"type":"string","description":"License type"},"display_name_source":{"type":"string","default":"manual","description":"Display name source"},"avatar_url":{"type":"string","default":null,"description":"User avatar URL"},"external_employee_id":{"type":"string","default":null,"description":"External directory employee identifier"}},"additionalProperties":false,"required":["uuid","display_name","status","license_type","display_name_source"]},"checks":{"type":"object","additionalProperties":true,"default":null,"description":"Policy checks for the record"},"access_source":{"type":"object","additionalProperties":true,"default":null,"description":"How the caller can access the record"}},"additionalProperties":false,"required":["type","record"]}},"additionalProperties":false,"required":["data"]}},"schema_48":{"kind":"json-schema","data":{"type":"number","default":1},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"number","default":20},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"number","default":null},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"number"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"string"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"goal_uuid":{"type":"string","description":"UUID of the goal being checked in"},"checkinable_uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the goal (deprecated, use goal_uuid)"},"children":[]}]}]}]},"value":{"type":"number","default":null,"description":"Checkin value"},"status":{"type":"string","enum":["not_started","in_progress","on_track","behind","at_risk","closed","postponed"],"default":"not_started","description":"Checkin status"},"note":{"type":"string","default":null,"description":"Checkin note"},"checkin_date":{"type":"string","description":"Checkin date (YYYY-MM-DD)"},"timezone_offset":{"type":"number","description":"Timezone offset in minutes"},"score":{"type":"number","description":"Score (only for closed status)"},"progress_mode":{"type":"string","enum":["manual","rollup","integration"],"description":"Progress mode for the goal"},"labels":{"type":"array","items":{"type":"string"},"description":"Label names to apply to the check-in"}},"additionalProperties":false,"required":["timezone_offset"]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","properties":{"value":{"type":"number","description":"Checkin value"},"status":{"type":"string","enum":["not_started","in_progress","on_track","behind","at_risk","closed","postponed"],"description":"Checkin status"},"note":{"type":"string","description":"Checkin note"},"score":{"type":"number","description":"Score (only for closed status)"},"labels":{"type":"array","items":{"type":"string"},"description":"Label names to apply to the check-in"}},"additionalProperties":false},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","description":"Goal title"},"description":{"type":"string","default":null,"description":"Goal description"},"time_period_uuid":{"type":"string","description":"Time period UUID. Its stored dates define the allowed goal date range."},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional start date (YYYY-MM-DD). Must fall within the selected time period and be on or before end_date. Omit to use the time period start."},"children":[]}]}]}]},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional end date (YYYY-MM-DD). Must fall within the selected time period and be on or after start_date. Omit to use the time period end."},"children":[]}]}]}]},"goal_type":{"type":"string","enum":["aspirational","committed"],"default":"aspirational","description":"Goal type"},"visibility":{"type":"string","enum":["public","limited"],"default":"public","description":"Goal visibility"},"team_uuids":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of team UUIDs"},"owner_uuids":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of owner UUIDs"},"labels":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of label names"},"delegate_uuids":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of delegate UUIDs"},"metric":{"type":"object","properties":{"name":{"type":"string","default":"Progress","description":"Metric name"},"start_value":{"type":"number","default":0,"description":"Start value"},"target_value":{"type":"number","default":100,"description":"Target value"},"unit":{"type":"string","enum":["percentage","number","dollar","euro","pound","swiss_franc"],"default":"percentage","description":"Unit of measurement"},"metric_type":{"type":"string","enum":["reach","stay_above","stay_below","stay_between"],"default":"reach","description":"Metric type"}},"additionalProperties":false},"parents":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of parent goals"},"visible_entities":{"type":"array","items":{"type":"object","properties":{"entity_type":{"type":"string","enum":["User","Team"],"description":"Whether the goal is scoped to a user or a team"},"entity_uuid":{"type":"string","description":"UUID of the user or team"},"mode":{"type":"string","enum":["direct","own","create","inherit"],"description":"How the entity was granted visibility: direct is an explicit selection, own is an owner or delegate or a team the goal is assigned to, create is the creator, inherit is inherited from elsewhere"}},"additionalProperties":false,"required":["entity_type","entity_uuid","mode"]},"default":[],"description":"Visible entities for limited visibility"}},"additionalProperties":false,"required":["title","time_period_uuid"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","description":"Goal title"},"description":{"type":"string","description":"Goal description"},"short_id":{"type":"string","description":"Custom short ID: 2-30 letters, digits, dashes or underscores (for example CAO-E-O100), stored upper-case and unique within the tenant"},"goal_type":{"type":"string","enum":["aspirational","committed"],"description":"Goal type"},"visibility":{"type":"string","enum":["public","limited"],"description":"Goal visibility"},"current_status":{"type":"string","enum":["not_started","in_progress","on_track","behind","at_risk","closed","postponed"],"description":"Current status"},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional start date (YYYY-MM-DD). Must fall within the selected time period and be on or before end_date. When changing the time period, omit to use the new period start."},"children":[]}]}]}]},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional end date (YYYY-MM-DD). Must fall within the selected time period and be on or after start_date. When changing the time period, omit to use the new period end."},"children":[]}]}]}]},"time_period_uuid":{"type":"string","description":"Time period UUID. Changing it resets omitted start and end dates to the new period boundaries."},"team_uuids":{"type":"array","items":{"type":"string"},"description":"Array of team UUIDs"},"owner_uuids":{"type":"array","items":{"type":"string"},"description":"Array of owner UUIDs"},"labels":{"type":"array","items":{"type":"string"},"description":"Array of label names"},"delegate_uuids":{"type":"array","items":{"type":"string"},"description":"Array of delegate UUIDs"},"progress_mode":{"type":"string","enum":["manual","rollup","integration"],"description":"Progress mode"},"metric":{"type":"object","properties":{"name":{"type":"string","default":"Progress","description":"Metric name"},"start_value":{"type":"number","default":0,"description":"Start value"},"target_value":{"type":"number","default":100,"description":"Target value"},"unit":{"type":"string","enum":["percentage","number","dollar","euro","pound","swiss_franc"],"default":"percentage","description":"Unit of measurement"},"metric_type":{"type":"string","enum":["reach","stay_above","stay_below","stay_between"],"default":"reach","description":"Metric type"}},"additionalProperties":false},"parents":{"type":"array","items":{"type":"string"},"default":[],"description":"Array of parent goals"},"visible_entities":{"type":"array","items":{"type":"object","properties":{"entity_type":{"type":"string","enum":["User","Team"],"description":"Whether the goal is scoped to a user or a team"},"entity_uuid":{"type":"string","description":"UUID of the user or team"},"mode":{"type":"string","enum":["direct","own","create","inherit"],"description":"How the entity was granted visibility: direct is an explicit selection, own is an owner or delegate or a team the goal is assigned to, create is the creator, inherit is inherited from elsewhere"}},"additionalProperties":false,"required":["entity_type","entity_uuid","mode"]},"default":[],"description":"Visible entities for limited visibility"}},"additionalProperties":false},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","properties":{"including_immediate_objectives":{"type":"boolean","default":false,"description":"Include immediate objectives in deletion"},"including_immediate_initiatives":{"type":"boolean","default":false,"description":"Include immediate initiatives in deletion"},"including_immediate_key_results":{"type":"boolean","default":false,"description":"Include immediate key results in deletion"},"delete_hierarchy":{"type":"boolean","default":false,"description":"Delete entire hierarchy"}},"additionalProperties":false},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"object","properties":{"name":{"type":"string","description":"Label name (unique within tenant)"},"description":{"type":"string","default":null,"description":"Label description"},"parent_uuid":{"type":"string","description":"UUID of parent label (parent must be a group)"},"is_group":{"type":"boolean","default":false,"description":"Whether this label is a group"},"color":{"type":"string","default":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code (e.g. #eb5757)"},"children":[]}]}]}]}},"additionalProperties":false,"required":["name"]}},"additionalProperties":false,"required":["label"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"object","properties":{"name":{"type":"string","description":"Label name"},"description":{"type":"string","description":"Label description"},"parent_uuid":{"type":"string","description":"UUID of parent label group, or blank to move the label to the root"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hex color code (e.g. #eb5757), or blank to clear"},"children":[]}]}]}]}},"additionalProperties":false}},"additionalProperties":false,"required":["label"]},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"object","properties":{"team":{"type":"object","properties":{"display_name":{"type":"string","description":"Team display name"},"icon":{"type":"string","description":"Lucide icon or initials; send with color"},"color":{"type":"string","enum":["gray","purple","blue","teal","green","yellow","orange","pink"],"description":"Team color token; send with icon"},"description":{"type":"string","default":null,"description":"Team description"},"parent_uuid":{"type":"string","default":null,"description":"Parent team UUID"},"owner_uuids":{"type":"array","items":{"type":"string"},"default":[],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of user UUIDs to be team owners in the format [\"uuid-1\", \"uuid-2\"]"},"children":[]}]}]}]},"member_uuids":{"type":"array","items":{"type":"string"},"default":[],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of user UUIDs to be team members in the format [\"uuid-1\", \"uuid-2\"]"},"children":[]}]}]}]}},"additionalProperties":false,"required":["display_name"]}},"additionalProperties":false,"required":["team"]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","properties":{"team":{"type":"object","properties":{"display_name":{"type":"string","description":"Team display name"},"icon":{"type":"string","description":"Lucide icon or initials; send with color"},"color":{"type":"string","enum":["gray","purple","blue","teal","green","yellow","orange","pink"],"description":"Team color token; send with icon"},"description":{"type":"string","description":"Team description"},"parent_uuid":{"type":"string","description":"Parent team UUID"},"status":{"type":"string","enum":["active","archived"],"description":"Team status"},"owner_uuids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of user UUIDs to be team owners in the format [\"uuid-1\", \"uuid-2\"]"},"children":[]}]}]}]},"member_uuids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of user UUIDs to be team members in the format [\"uuid-1\", \"uuid-2\"]"},"children":[]}]}]}]}},"additionalProperties":false}},"additionalProperties":false,"required":["team"]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"type":"object","properties":{"email":{"type":"string","description":"User email address"},"display_name":{"type":"string","description":"User display name"},"license_type":{"type":"string","enum":["standard","hris_only","guest"],"default":"standard","description":"User license type"},"status":{"type":"string","enum":["active","closed"],"default":"active","description":"User status"},"manager_uuid":{"type":"string","default":null,"description":"Manager UUID"},"profile_attributes":{"type":"object","properties":{"first_name":{"type":"string","default":null,"description":"First name"},"last_name":{"type":"string","default":null,"description":"Last name"},"job_title":{"type":"string","default":null,"description":"Job title"},"timezone":{"type":"string","default":null,"description":"Timezone"},"locale":{"type":"string","default":"en","description":"Locale"},"about":{"type":"string","default":null,"description":"About text"}},"additionalProperties":false}},"additionalProperties":false,"required":["email","display_name"]}},"additionalProperties":false,"required":["user"]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"object","properties":{"user":{"type":"object","properties":{"display_name":{"type":"string","description":"User display name"},"avatar_url":{"type":"string","description":"Avatar URL; only applied when the user has no avatar yet"},"status":{"type":"string","enum":["active","closed"],"description":"User status"},"manager_uuid":{"type":"string","description":"Manager UUID"},"license_type":{"type":"string","enum":["standard","hris_only","guest"],"description":"User license type"},"profile_attributes":{"type":"object","properties":{"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"job_title":{"type":"string","description":"Job title"},"timezone":{"type":"string","description":"Timezone"},"locale":{"type":"string","description":"Locale"},"about":{"type":"string","description":"About text"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"required":["user"]},"id":"schema_63"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.rhythms.ai"}]},"options":{"hideDownloadButtons":true,"codeSamples":{"languages":[]},"theme":{"sidebar":{"backgroundColor":"ivory"}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/rest/v2.json?download"},{"url":"/_bundle/rest/v2.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Rhythms REST API","description":"The official REST API for Rhythms - designed for third-party integrations, mobile apps, and external tooling. This API follows REST conventions and provides clean, predictable endpoints for managing OKRs (Objectives, Key Results, and Initiatives).\n\n**Base URL**\n\nhttps://api.rhythms.ai\n\nAll REST API v2 endpoints are prefixed with /rest/v2/\n\n**Response Format**\n\nAll responses use JSON format with consistent error handling and pagination. Successful responses include requested data, while error responses provide detailed troubleshooting information.\n\n**Error Handling**\n\nThe API uses standard HTTP status codes with detailed JSON error messages.\n\nPerfect for building integrations, mobile apps, reporting dashboards, and automation workflows.\n\n## Authentication\n\nAll API endpoints require authentication using Bearer token authorization. Include this header with every request:\n\n- **Authorization:** Bearer token for your account access\n\nGetting API Credentials: Contact support at support@rhythms.ai to obtain your access token.\n\n## Rate Limiting\n\nStandard rate limits apply to all endpoints to ensure fair usage and optimal performance for all users.\n\nIf you need higher limits for your integration, please contact our support team at support@rhythms.ai with details about your use case.\n\n## Pagination\n\nList endpoints support pagination using query parameters:\n\n- **page:** Page number (default: 1)\n- **limit:** Items per page (default: 20, max: 100)\n\nResponse includes pagination metadata in the `pagy` object with `next` indicating the next page number (or null if no more pages)."}},"baseSlug":"/rest/v2","routesMapping":{}}