List several users by IDs.

List several users by IDs. Get several users of the process space by id, including the state of a pending invitation each. Ids that do not resolve to a user are skipped silently, so the result may be shorter than the request.

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

POST/v1/warehouses/{warehouseId}/users/byids

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

ID of warehouse

Request body

requiredapplication/json

IDs of users

Array of string

string

Responses

200

The Users

Array of 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

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 warehouse

Bodyapplication/json

Request body

Request

curl -X POST 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/users/byids' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '[
  "string"
]'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/users/byids", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "[\n  \"string\"\n]"
});

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"
    ]
  }
]