1
2
3
Staff(
    int StaffID
)

Get information for one Staff User.

Note: available since RPM21.

Request

Request Data:

  • (int) StaffID: the id for the Staff User.
1
2
3
{
    "StaffID": <int>
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
  "Result": {
      "Username": <string>,
      "UserID": <int>,
      "Enabled": <bool>,
      "StaffID": <int>,
      "Name": <string>,
      "RoleID": <int>,
      "Role": <string>,
      "Groups": [
          {
              "ID": <int>,
          },
          // ... more staff groups
      ],
      "Added": <string>,
      "Contact": {
          "ContactID": <int>,
          "Salutation": <string>,
          "FirstName": <string>,
          "LastName": <string>,
          "Title": <string>,
          "Email": <string>,
          "PhoneNumbers": [
              {
                  "PhoneNumberID": <int>,
                  "Type": <int>,
                  "Number": <string>
              },
              // ... more phone numbers
          ]
      },
      "Fields": [
          {
              "Field": <string>,
              "Uid": <string>,
              "Format": <int>,
              "Value": <string>
          },
          // ... more custom fields
      ]
  }
}

Errors

  • “Staff not found”