{"swagger":"2.0","info":{"description":"This is a Swagger generated doc for Kizeo REST API 4. You can find additionnal documentation here : [Online documentation](\/doc).","version":"4.0.0","title":"Kizeo REST","termsOfService":"","contact":{"email":"support@kizeo.com"}},"host":"www.kizeoforms.com","basePath":"\/rest\/public\/v4","tags":[{"name":"list","description":"Methods for managing advanced lists","externalDocs":{"description":"","url":"http:\/\/swagger.io"}}],"schemes":["https"],"paths":{"\/lists\/{list_id}\/definition":{"get":{"tags":["list"],"summary":"Get list definition","description":"Get the definition of the list properties","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"}],"responses":{"200":{"description":"","schema":{"$ref":"#\/definitions\/ListDefinition"}},"404":{"description":"List not found"}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items":{"get":{"tags":["list"],"summary":"List items of given list. You can't get more than 500 at a time.","description":"This function provides you a list of the items of the advanced list.","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"query","name":"search","required":false,"type":"string","description":"Pattern to search"},{"in":"query","name":"offset","required":false,"type":"string","description":"Offset"},{"in":"query","name":"limit","required":false,"type":"string","description":"Number of items to get"},{"in":"query","name":"sort","required":false,"type":"string","description":"Target for sorting"},{"in":"query","name":"direction","required":false,"type":"string","description":"Sorting : asc or desc"}],"responses":{"200":{"description":"List of items","schema":{"$ref":"#\/definitions\/ListItems"}},"404":{"description":"List not found"}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items\/{item_id}":{"get":{"tags":["list"],"summary":"Get an item","description":"Get an item of the list by ID","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"path","name":"item_id","required":true,"description":"ID of the item"}],"responses":{"200":{"description":"","schema":{"$ref":"#\/definitions\/ListItem"}},"404":{"description":"Item not found"},"422":{"description":"","schema":{"$ref":"#\/definitions\/Error422"}}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items ":{"post":{"tags":["list"],"summary":"Create list items. You can't create more than 500 at a time.","description":"Create multiple list items","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"body","name":"body","required":true,"description":"Items to create","schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#\/definitions\/ItemToCreate"}}}}}],"responses":{"200":{"description":"","schema":{"$ref":"#\/definitions\/ListItemCreate"}},"404":{"description":"List not found"}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items  ":{"patch":{"tags":["list"],"summary":"Edit list items. You can't edit more than 500 at a time.","description":"Edit multiple list items ","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"body","name":"body","required":true,"description":"Items to update","schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","$ref":"#\/definitions\/ItemToUpdate"}}}}}],"responses":{"200":{"description":"","schema":{"$ref":"#\/definitions\/ListItems"}},"404":{"description":"List not found"}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items\/{item_id} ":{"patch":{"tags":["list"],"summary":"Edit list item","description":"Edit one list item by given ID","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"path","name":"item_id","required":true,"description":"ID of the item"},{"in":"body","name":"body","required":true,"description":"Item to update","schema":{"$ref":"#\/definitions\/ItemToCreate"}}],"responses":{"200":{"description":"","schema":{"$ref":"#\/definitions\/ListItem"}},"404":{"description":"Item not found"},"422":{"description":"","schema":{"$ref":"#\/definitions\/Error422"}}},"security":[{"authentication":[]}]}},"\/lists\/{list_id}\/items\/{item_id}  ":{"delete":{"tags":["list"],"summary":"Delete list item","description":"Delete list item given by ID","produces":["application\/json"],"parameters":[{"in":"path","name":"list_id","required":true,"type":"integer","description":"ID of the list"},{"in":"path","name":"item_id","required":true,"description":"ID of the item"}],"responses":{"204":{"description":"","schema":{"$ref":"#\/definitions\/ListItemDelete"}},"404":{"description":"Item not found"},"422":{"description":"","schema":{"$ref":"#\/definitions\/Error422"}}},"security":[{"authentication":[]}]}}},"securityDefinitions":{"authentication":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"DefaultResponse":{"type":"object","properties":{"status":{"type":"string","enum":["ok","error"]},"message":{"type":"string"},"data":{"type":"object"}}},"ListItems":{"type":"array","items":{"$ref":"#\/definitions\/ListItem"}},"ListItem":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"properties":{"type":"object","properties":{"property1":{"type":"string"}}},"sync_token":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"ListItemCreate":{"type":"array","items":{"type":"string"}},"ListItemDelete":{"type":"string","enum":["OK"]},"ListDefinition":{"type":"object","properties":{"list_name":{"type":"string"},"properties_definition":{"type":"object","properties":{"property_id1":{"type":"object","properties":{"display_name":{"type":"string"},"type":{"type":"string"},"id":{"type":"string"}}}}},"order_by":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["label"]},"type":{"type":"string","enum":["asc","desc"]}}}},"group_by":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["property_id1"]},"type":{"type":"string","enum":["asc","desc"]}}}}}},"PropertiesArray":{"type":"object","properties":{"property1":{"type":"string"}}},"ItemToCreate":{"type":"object","properties":{"label":{"type":"string"},"properties":{"type":"object","properties":{"property1":{"type":"string"}}}}},"ItemToUpdate":{"type":"object","properties":{"item_id":{"type":"string"},"label":{"type":"string"},"properties":{"type":"object","properties":{"property1":{"type":"string"}}}}},"ItemToReceive":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"properties ":{"$ref":"#\/definitions\/PropertiesArray"}}},"Error422":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object"}}}},"externalDocs":{"description":"Find out more about Swagger","url":"http:\/\/swagger.io"}}