{ "opencollection": "1.0.0", "info": { "name": "API V1 API Partners Customers API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "X-Api-Partner-Id", "value": "{{X-Api-Partner-Id}}", "placement": "header" } }, "items": [ { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Get a list of all customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/tenants/:tenant_id/customers", "params": [ { "name": "tenant_id", "value": "1", "type": "path" }, { "name": "last_name", "value": "null", "type": "query", "description": "Filter response to include only customers with a last_name containing the corresponding characters sequence." }, { "name": "email", "value": "null", "type": "query", "description": "Filter response to include only customers with contact_email containing the corresponding character sequence." }, { "name": "phone_number", "value": "null", "type": "query", "description": "Filter response to include only customers with phone numbers containing the corresponding digit sequence." }, { "name": "phone_number_preferred_only", "value": "null", "type": "query", "description": "Toggle to include only preferred phone numbers according to the search given in phone_number" }, { "name": "type", "value": "individual", "type": "query", "description": "Filter response to include only corporate or individual (null including) customers. Possible values: 'corporate' and 'individual'." }, { "name": "page", "value": "1", "type": "query" }, { "name": "per_page", "value": "30", "type": "query" }, { "name": "updated_after", "value": "2022-10-24T12%3A00%3A00%2B08%3A00", "type": "query", "description": "Filter response to only include records updated after a given time" } ] }, "docs": "Get a list of all customer" }, { "info": { "name": "Create a customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/tenants/:tenant_id/customers", "params": [ { "name": "tenant_id", "value": "1", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a customer" }, { "info": { "name": "Get a specific customer by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/tenants/:tenant_id/customers/:id", "params": [ { "name": "tenant_id", "value": "1", "type": "path" }, { "name": "id", "value": "1", "type": "path" } ] }, "docs": "Get a specific customer by ID" }, { "info": { "name": "Update a specific customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/tenants/:tenant_id/customers/:id", "params": [ { "name": "tenant_id", "value": "1", "type": "path" }, { "name": "id", "value": "1", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific customer" } ] } ], "bundled": true }