Permissions

GET 
/permissions

Returns whether or not the user is allowed to create shifts on SideShift.ai. Learn more.

info

SideShift.ai does not allow proxying user requests. This means that the user should either directly interact with the SideShift.ai REST API, or if the API requests are sent from the integration's own server, the x-user-ip header must be set to the end-user IP address.

Request

Header Parameters

x-user-ip string

end-user IP address for integrations API requests

Responses

200

OK

application/json

Schema

Schema

createShift booleanrequired

Example

Allowed

{
  "createShift": true
}

Restricted

{
  "createShift": false
}

403

Forbidden

application/json

Schema

Schema

error object
message stringrequired

Example

{
  "error": {
      "message": "Access denied. See https://sideshift.ai/access-denied"
  }
}

Loading...