API Reference

Roles & Permissions

Staff roles and RBAC.

14 endpoints· Auth: API Key
get/api/v1/store/integrations/rbac/permissions API Key

Get permissions

Query parameters

tenantType
string
—
storeId
string (uuid)
—
deliveryCompanyId
string (uuid)
—
branchId
string (uuid)
—
page
integer (int32)
—
per_page
integer (int32)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/permissions" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/rbac/roles API Key

Get roles

Query parameters

tenantType
string
—
storeId
string (uuid)
—
deliveryCompanyId
string (uuid)
—
branchId
string (uuid)
—
page
integer (int32)
—
per_page
integer (int32)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/rbac/roles API Key

Create roles

Request body

application/json
{
  "name": "string",
  "description": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}
name
string
—
description
string
—
storeId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "name": "string",
  "description": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
put/api/v1/store/integrations/rbac/roles/{roleId} API Key

Update roleId

Path parameters

roleIdrequired
string (uuid)
—

Request body

application/json
{
  "name": "string",
  "description": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}
name
string
—
description
string
—
storeId
string (uuid)
—

Responses

200Success
cURL
curl -X PUT "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles/{roleId}" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "name": "string",
  "description": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/rbac/roles/{roleId} API Key

Delete roleId

Path parameters

roleIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles/{roleId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/rbac/roles/{roleId}/permissions API Key

Get permissions

Path parameters

roleIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles/{roleId}/permissions" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/rbac/roles/{roleId}/permissions API Key

Create permissions

Path parameters

roleIdrequired
string (uuid)
—

Request body

application/json
{
  "permissionId": "00000000-0000-0000-0000-000000000000"
}
permissionId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles/{roleId}/permissions" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "permissionId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/rbac/roles/{roleId}/permissions/{permissionId} API Key

Delete permissionId

Path parameters

roleIdrequired
string (uuid)
—
permissionIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/roles/{roleId}/permissions/{permissionId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/rbac/users API Key

Get users

Query parameters

tenantType
string
—
storeId
string (uuid)
—
deliveryCompanyId
string (uuid)
—
branchId
string (uuid)
—
page
integer (int32)
—
per_page
integer (int32)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/rbac/users API Key

Create users

Request body

application/json
{
  "fullName": "string",
  "phone": "string",
  "email": "string",
  "password": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}
fullName
string
—
phone
string
—
email
string
—
password
string
—
storeId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "fullName": "string",
  "phone": "string",
  "email": "string",
  "password": "string",
  "storeId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/rbac/users/{userId} API Key

Delete userId

Path parameters

userIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users/{userId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/rbac/users/{userId}/roles API Key

Get roles

Path parameters

userIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users/{userId}/roles" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/rbac/users/{userId}/roles API Key

Create roles

Path parameters

userIdrequired
string (uuid)
—

Request body

application/json
{
  "roleId": "00000000-0000-0000-0000-000000000000"
}
roleId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users/{userId}/roles" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "roleId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/rbac/users/{userId}/roles/{roleId} API Key

Delete roleId

Path parameters

userIdrequired
string (uuid)
—
roleIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/rbac/users/{userId}/roles/{roleId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu