> For the complete documentation index, see [llms.txt](https://docs.spurtcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spurtcommerce.com/api-reference/store/customer-profile/customer-permissions.md).

# Customer Permissions

Retrieve customer permission modules and assignments.

## List customer permission modules.

> List customer permission modules.\
> \
> \*\*Authentication:\*\* Customer authorization header is documented; endpoint returns permission modules.\
> \
> \*\*Feature area:\*\* Customer profile\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerPermissionModuleController.ts\`\
> \
> \*\*Request example provenance:\*\* Exact response field structure from source API comment; sample values copied from it.\
> \
> \*\*Response example provenance:\*\* Exact response field structure from source API comment; sample values copied from it.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Customer permissions","description":"Retrieve customer permission modules and assignments."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"paths":{"/api/customer-permission-module":{"get":{"operationId":"getApiCustomerPermissionModule","summary":"List customer permission modules.","description":"List customer permission modules.\n\n**Authentication:** Customer authorization header is documented; endpoint returns permission modules.\n\n**Feature area:** Customer profile\n\n**Implementation source:** `src/api/store/controllers/CustomerPermissionModuleController.ts`\n\n**Request example provenance:** Exact response field structure from source API comment; sample values copied from it.\n\n**Response example provenance:** Exact response field structure from source API comment; sample values copied from it.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Customer permissions"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Query parameter limit."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"Query parameter offset."},{"name":"count","in":"query","required":false,"schema":{"type":"boolean"},"description":"Query parameter count."}],"responses":{"200":{"description":"Successful response. Exact response field structure from source API comment; sample values copied from it.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slugName":{"type":"string"},"sortOrder":{"type":"integer"},"customerPermissionModule":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slugName":{"type":"string"},"moduleGroupId":{"type":"integer"}},"additionalProperties":true}}},"additionalProperties":true}}},"additionalProperties":true}}}}}}}}}
```

## Get permission assignments for a customer role/group.

> Get permission assignments for a customer role/group.\
> \
> \*\*Authentication:\*\* Customer authorization header is documented.\
> \
> \*\*Feature area:\*\* Customer profile\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerPermissionModuleController.ts\`\
> \
> \*\*Request example provenance:\*\* Source API comment defines response wrapper; pageId is a sample value.\
> \
> \*\*Response example provenance:\*\* Source API comment defines response wrapper; pageId is a sample value.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Customer permissions","description":"Retrieve customer permission modules and assignments."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"paths":{"/api/customer-permission-module/group/{id}/permission":{"get":{"operationId":"getApiCustomerPermissionModuleGroupIdPermission","summary":"Get permission assignments for a customer role/group.","description":"Get permission assignments for a customer role/group.\n\n**Authentication:** Customer authorization header is documented.\n\n**Feature area:** Customer profile\n\n**Implementation source:** `src/api/store/controllers/CustomerPermissionModuleController.ts`\n\n**Request example provenance:** Source API comment defines response wrapper; pageId is a sample value.\n\n**Response example provenance:** Source API comment defines response wrapper; pageId is a sample value.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Customer permissions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Value for id."}],"responses":{"200":{"description":"Successful response. Source API comment defines response wrapper; pageId is a sample value.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"pageId":{"type":"integer"}},"additionalProperties":true},"status":{"type":"string"}},"additionalProperties":true}}}}}}}}}
```

## Get permission data for the authenticated customer user.

> Get permission data for the authenticated customer user.\
> \
> \*\*Authentication:\*\* Customer bearer token required.\
> \
> \*\*Feature area:\*\* Customer profile\
> \
> \*\*Implementation source:\*\* \`src/api/store/controllers/CustomerPermissionModuleController.ts\`\
> \
> \*\*Request example provenance:\*\* Source-defined endpoint and response wrapper.\
> \
> \*\*Response example provenance:\*\* Source-defined endpoint and response wrapper.\
> \
> \> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Store API","version":"6.0.0"},"tags":[{"name":"Customer permissions","description":"Retrieve customer permission modules and assignments."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/customer-permission-module/permission-me":{"get":{"operationId":"getApiCustomerPermissionModulePermissionMe","summary":"Get permission data for the authenticated customer user.","description":"Get permission data for the authenticated customer user.\n\n**Authentication:** Customer bearer token required.\n\n**Feature area:** Customer profile\n\n**Implementation source:** `src/api/store/controllers/CustomerPermissionModuleController.ts`\n\n**Request example provenance:** Source-defined endpoint and response wrapper.\n\n**Response example provenance:** Source-defined endpoint and response wrapper.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Customer permissions"],"responses":{"200":{"description":"Successful response. Source-defined endpoint and response wrapper.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"object","properties":{"permission":{"type":"object","properties":{},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true}}}}}}}}}
```
