getWorkflowUsers

Click to copy

Get all users available to a user in the workflow system

Get organization users associated with Workflow Manager roles, to which the current user can assign work based on their Workflow Manager assignment privileges. Returns the users' user name, full name, first name, last name, email, thumbnail, and whether they can be assigned work based on the current user's Workflow Manager assignment privileges.

  • If the user has jobAssignAny privilege all users associated with Workflow Manager roles will be returned and indicated as assignable.
  • If the user has jobAssignGroup privilege all the users from the groups that the user is a member of and are associated with Workflow Manager roles will be assignable.
  • If the user has jobAssignIndividual privilege the current user is indicated as assignable.

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/community/users \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "users": [
    {
      "username": "string",
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "thumbnail": "string",
      "isAssignable": true
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

List of assignable users for a user in the workflow system

Inline

404

Not Found

error

WorkflowExceptionDTO

Response details

Status Code 200

UserDescriptions

NameTypeRequired

users

username

string

fullName

string

firstName

string¦null

lastName

string¦null

email

string¦null

thumbnail

string¦null

isAssignable

boolean

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.