{ "opencollection": "1.0.0", "info": { "name": "Brickwork Admin Appointments Admin Customers API", "version": "v3" }, "items": [ { "info": { "name": "Admin Customers", "type": "folder" }, "items": [ { "info": { "name": "List all Company Customers", "type": "http" }, "http": { "method": "GET", "url": "https://production.brickworksoftware.com/:locale/api/v3/admin/customers", "params": [ { "name": "locale", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "Page number of your query" }, { "name": "query", "value": "", "type": "query", "description": "Query parameters for all company customers" }, { "name": "query[start_date]", "value": "", "type": "query", "description": "Filter Company Customers by created at start date \"YYYY-MM-DD\", defaults to 30 days back" }, { "name": "query[end_date]", "value": "", "type": "query", "description": "Filter Company Customers by created at end date \"YYYY-MM-DD\", defaults to today" }, { "name": "query[code]", "value": "", "type": "query", "description": "Filter customers by customer code [CODE1,CODE2,CODE3]" }, { "name": "query[id]", "value": "", "type": "query", "description": "Filter customers by customer ids [1,2,3]" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "Example: `http://company.com/api/v3/admin/customers?query[start_date]=2016-05-28`" }, { "info": { "name": "Create Customers", "type": "http" }, "http": { "method": "POST", "url": "https://production.brickworksoftware.com/:locale/api/v3/admin/customers", "params": [ { "name": "locale", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "Create Customers" }, { "info": { "name": "Show Customer", "type": "http" }, "http": { "method": "GET", "url": "https://production.brickworksoftware.com/:locale/api/v3/admin/customers/:id_or_code", "params": [ { "name": "id_or_code", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "Show Customer" }, { "info": { "name": "Update Customers", "type": "http" }, "http": { "method": "PUT", "url": "https://production.brickworksoftware.com/:locale/api/v3/admin/customers/:customer_id_or_code", "params": [ { "name": "customer_id_or_code", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "Update Customers" } ] } ], "bundled": true }