{ "opencollection": "1.0.0", "info": { "name": "FieldPulse Custom Fields API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Custom Fields", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a custom field by ID", "type": "http" }, "http": { "method": "GET", "url": "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields/:customfieldId", "params": [ { "name": "customfieldId", "value": "", "type": "path" } ] }, "docs": "Retrieve a custom field by ID" }, { "info": { "name": "Update custom field by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields/:customfieldId", "params": [ { "name": "customfieldId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update custom field by ID" }, { "info": { "name": "Delete custom field by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields/:customfieldId", "params": [ { "name": "customfieldId", "value": "", "type": "path" } ] }, "docs": "Delete custom field by ID" }, { "info": { "name": "Retrieve custom fields list", "type": "http" }, "http": { "method": "GET", "url": "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Defaults to 20 items per page, maximum 100 items allowed." }, { "name": "object_type", "value": "", "type": "query", "description": "Allowed values: customer, job, invoice, item, maintenance_agreement, project, asset, material_list." }, { "name": "page", "value": "", "type": "query", "description": "Page number. Starts from 1, defaults to 1." }, { "name": "calculate_count", "value": "", "type": "query", "description": "true or false. If true, in response will be included also total count" }, { "name": "filter", "value": "", "type": "query", "description": "Array of attribute, operator, and value parts." }, { "name": "sort", "value": "", "type": "query", "description": "Array of attribute and order values." }, { "name": "rel", "value": "", "type": "query", "description": "array consisting of indices with the desired relation to include" } ] }, "docs": "Retrieve custom fields list" }, { "info": { "name": "Create a custom field", "type": "http" }, "http": { "method": "POST", "url": "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields", "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom field" } ] } ], "bundled": true }