{ "opencollection": "1.0.0", "info": { "name": "Admin Account / Address Addresses API", "version": "v3" }, "items": [ { "info": { "name": "Addresses", "type": "folder" }, "items": [ { "info": { "name": "Return a list of Addresses", "type": "http" }, "http": { "method": "GET", "url": "http://{defaultHost}/api/v2/platform/addresses", "params": [ { "name": "page", "value": "1", "type": "query" }, { "name": "per_page", "value": "50", "type": "query" }, { "name": "include", "value": "user,country,state", "type": "query", "description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes" }, { "name": "filter[user_id_eq]", "value": "1", "type": "query" }, { "name": "filter[firstname_cont]", "value": "John", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a list of Addresses" }, { "info": { "name": "Create an Address", "type": "http" }, "http": { "method": "POST", "url": "http://{defaultHost}/api/v2/platform/addresses", "params": [ { "name": "include", "value": "user,country,state", "type": "query", "description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates an Address" }, { "info": { "name": "Return an Address", "type": "http" }, "http": { "method": "GET", "url": "http://{defaultHost}/api/v2/platform/addresses/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "include", "value": "user,country,state", "type": "query", "description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns an Address" }, { "info": { "name": "Update an Address", "type": "http" }, "http": { "method": "PATCH", "url": "http://{defaultHost}/api/v2/platform/addresses/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "include", "value": "user,country,state", "type": "query", "description": "Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates an Address" }, { "info": { "name": "Delete an Address", "type": "http" }, "http": { "method": "DELETE", "url": "http://{defaultHost}/api/v2/platform/addresses/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes an Address" } ] } ], "bundled": true }