{"openapi":"3.0.0","info":{"description":"\nThis is a collection of Client Details\n\nThe base endpoint URL for this API in production is: `https://marko.aramark.net/v1/organization`.\n\nFor testing the API with the \"Try\" tool on this page or in your app, use either our testing server \"qa-marko\" or our development server \"dev-marko\".\n","version":"1.0.0-oas3","title":"Client Details"},"security":[{"apiKey":[]}],"paths":{"/clients":{"get":{"operationId":"getOrganizationClients","tags":["Clients"],"summary":"Returns a collection of Client Attributes","description":"![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","parameters":[{"$ref":"#/components/parameters/profitCenterParam"},{"$ref":"#/components/parameters/searchParam"},{"$ref":"#/components/parameters/formatParam"},{"$ref":"#/components/parameters/pageParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"Collection of Client Attributes","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success' or 'Error'","default":"Success"},"count":{"type":"string","description":"Number of records returned"},"clients":{"type":"array","items":{"$ref":"#/components/schemas/clients"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}}},"servers":[{"url":"https://qa-marko.aramark.net/v1/organization","description":"Testing server"},{"url":"https://dev-marko.aramark.net/v1/organization"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"apikey","description":"This HTTP Header variable will verify permissions."}},"parameters":{"profitCenterParam":{"in":"query","name":"org_value","description":"Provide profit center code to filter data set","schema":{"type":"string"}},"pageParam":{"in":"query","name":"page","description":"Page number of result set","schema":{"type":"number","default":1}},"sizeParam":{"in":"query","name":"size","description":"Number of records to be returned in each page of result set","schema":{"type":"string","default":50}},"searchParam":{"in":"query","name":"search","description":"Used to search a specific Client.  Will match against Name and Value or Client or Profit Center or Client Family.  Maximum length of 20 characters.","schema":{"type":"string"}},"formatParam":{"in":"query","name":"format","required":false,"description":"allows to change the output to a desired format. 'JSON' - JSON, 'CSV' - CSV, 'XLS' - Excel","schema":{"type":"string","enum":["JSON","CSV","XLS"]}},"bypassCacheParam":{"in":"header","name":"bypass-cache","description":"This HTTP Header variable will bypass cache.","schema":{"type":"string","enum":["true","false"],"default":"false"}},"smokeParam":{"in":"header","name":"smoke","description":"When set to 'true' this HTTP header variable will route the API call to the Integration testing environment. Only applicable in QA.","schema":{"type":"string"}}},"schemas":{"clients":{"type":"object","properties":{"org_source":{"type":"string","description":"Country code for the client"},"profit_center":{"type":"string","description":"Profit Center value for the client"},"profit_center_name":{"type":"string","description":"Profit Center name for the client"},"client_code":{"type":"string","description":"Client Code for the client"},"client_name":{"type":"string","description":"Name of the client"},"client_family_code":{"type":"string","description":"Family Code for the client"},"client_family_name":{"type":"string","description":"Name of the client family"},"global_family_code":{"type":"string","description":"Global family code for the client"},"global_family_name":{"type":"string","description":"Global family name for the client"}}}}}}