{ "opencollection": "1.0.0", "info": { "name": "Square ApplePay CustomerGroups API", "version": "2.0" }, "items": [ { "info": { "name": "CustomerGroups", "type": "folder" }, "items": [ { "info": { "name": "Square List Customer Groups", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/groups", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the list of customer groups of a business." }, { "info": { "name": "Square Create Customer Group", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/customers/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new customer group for a business.\n\nThe request must include the `name` value of the group." }, { "info": { "name": "Square Retrieve Customer Group", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a specific customer group as identified by the `group_id` value." }, { "info": { "name": "Square Update Customer Group", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a customer group as identified by the `group_id` value." }, { "info": { "name": "Square Delete Customer Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://connect.squareup.com/v2/customers/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the customer group to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a customer group as identified by the `group_id` value." } ] } ], "bundled": true }