SweetConnect LogoSweetConnect
ApiShare documents

Check if recipient exists

Checks whether the recipient email belongs to an existing user and returns their status.

Access restricted to roles:

  • admin
  • producer-admin
  • producer-user
GET
/v1/shares/check-recipient/{email}
AuthorizationBearer <token>

In: header

Path Parameters

email*string

Email address of the recipient to check

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://dev.sweetconnect.io/api/storage/v1/shares/check-recipient/user@example.com"
{
  "data": {}
}
{
  "errors": [
    {
      "errorCode": "BadRequest",
      "message": "The request payload is invalid.",
      "extension": {}
    }
  ]
}
{
  "errors": [
    {
      "errorCode": "Unauthorized",
      "message": "Authentication is required to access this resource.",
      "extension": {}
    }
  ]
}
{
  "errors": [
    {
      "errorCode": "NoPermission",
      "message": "You do not have permission to access this resource.",
      "extension": {}
    }
  ]
}
{
  "errors": [
    {
      "errorCode": "UnprocessableEntity",
      "message": "Operation not allowed for this entity type.",
      "extension": {
        "entityType": "Document"
      }
    }
  ]
}
{
  "errors": [
    {
      "errorCode": "InternalServerError",
      "message": "An unexpected error occurred. See logs for further details or create a support ticket.",
      "extension": {}
    }
  ]
}