List a single user by email address.

List a single user by email address. Get a user of the process space by email address, including the state of a pending invitation if there is one. The address is matched case-insensitively; an unknown address yields 404.

Security: Any user holding a Bpanda licence for the process space.

GET/v1/warehouses/{warehouseId}/users/email/{email}

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

ID of warehouse

emailstringrequired

EMail of user

Responses

200

The User

displayNamestringrequired

divisionstringrequired

emailsEMail[]required

Show properties

Array of EMail

typestringrequired

valuestringrequired

favoritesFavorite[]required

Show properties

Array of Favorite

refIdstringrequired

typestringrequired

versioninteger<int64>required

firstnamestringrequired

genderstringrequired

historyHistoryEntry[]required

Show properties

Array of HistoryEntry

idstringrequired

lastVisitedstringrequired

typeHistoryKindrequired

Allowed:Process

valuestringrequired

versioninteger<int64>required

warehouseIdstringrequired

idstringrequired

invitedbooleanrequired

invitedAtstringrequired

lastnamestringrequired

mobilestringrequired

organizationstringrequired

phonestringrequired

preferredLanguagestringrequired

scimEmailstringrequired

telefonestringrequired

thumbnailstringrequired

titlestringrequired

warehouseIdsstring[]required

404

No user with this email in the process space

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)API keyRemember on this deviceInclude my values in samples

Parameters

warehouseIdpath*ID of warehouseemailpath*EMail of user

Request

curl -X GET 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/users/email/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/users/email/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY"
  }
});

Response

{
  "displayName": "string",
  "division": "string",
  "emails": [
    {
      "type": "string",
      "value": "string"
    }
  ],
  "favorites": [
    {
      "refId": "string",
      "type": "string",
      "version": 0
    }
  ],
  "firstname": "string",
  "gender": "string",
  "history": [
    {
      "id": "string",
      "lastVisited": "string",
      "type": "Process",
      "value": "string",
      "version": 0,
      "warehouseId": "string"
    }
  ],
  "id": "string",
  "invited": true,
  "invitedAt": "string",
  "lastname": "string",
  "mobile": "string",
  "organization": "string",
  "phone": "string",
  "preferredLanguage": "string",
  "scimEmail": "string",
  "telefone": "string",
  "thumbnail": "string",
  "title": "string",
  "warehouseIds": [
    "string"
  ]
}

"string"