BigTime's staff api provides access to the list of users in the system.

Getting a listing of Staff

try it

• Click the GET button below to view the information returned by this url.

• Get

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /staff?{ShowInactive=true}
HTTP RESPONSE:  (array of Staff objects ("basic" view -- see below for details)

Pulling the detail for a specific staffer.

try it

• BasicDetailed
• Get

You can use a simple GET request to pull the details associated with a single entry. Note that the BASIC view fields will be returned by default. You should also note that a user cannot pull data for an entity they are not permitted to view in the BigTime program. This can often become a problem when back-end services are using the api without system-wide permissions.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /staff/detail/{systemid}?&View={Detailed/Basic}
HTTP RESPONSE:  (Staff object -- see below for details)

Creating a NEW staffer.

try it

• {"SName": "Test Staff Name", "EMail": "TestStaffEmail@email.com"}
• Post

Note that only the fields listed in the Update view (below) should be included in your post to this url. Any other data will be ignored. BigTime doesn't care about the order in which field data is posted, and none of the fields are case sensitive. Note that any validation errors will return a 400 error, and an invalid permission will return a 405 (eg - attempting to create a staffer when you don't have that right).

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /staff/add/?inviteUser={true/false}
HTTP RESPONSE:  (Staff object -- see below for details)

Staffer Custom Fields

By submitting a simple query to this api, you'll get a list of custom fields for a specific staffer.

Getting a list of staffer custom fields.

try it

• Get

You can use a GET request to pull the list of custom fields for a specific staffer. Note that a user cannot pull staffer custom field data for a staffer they are not permitted to view in the BigTime program. This can often become a problem when back-end services are using the api without system-wide permissions. No additional parameters are required/supported.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP GET:  /staff/UDFList/{sid}
HTTP RESPONSE:  (array of Staffer Custom Field objects -- see below for details)

Getting a list of staffer custom fields by field name.

try it

• Submit

You can use a POST request to pull a list of custom fields with a specific field name. If you decide to not specify a field name or pass an empty list, the below query will return a full list of custom fields for all your staffers. Note that a user cannot pull staffer custom field data for a staffer they are not permitted to view in the BigTime program. This can often become a problem when back-end services are using the api without system-wide permissions. No additional parameters are required/supported.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP POST:  /staff/UDFListByName
POST CONTENT:
[
	"Custom Field Name 1",
	"Custom Field Name 2",
	..
]
HTTP RESPONSE:  (array of Staffer Custom Field objects -- see below for details)

Updating existing custom fields on a staffer.

try it

• Submit

You can use a POST request to update an existing staffer's custom field list. To do this, POST to this URL with the staffer SID and a JSON array of Staffer Custom Fields objects. Your staffer's custom fields will be set according to the JSON array passed to this URL. Note again, validation errors will return a 400 error, and an invalid permission will return a 405.

HEADERS:  X-Auth-Token:{YourAPIToken}, X-Auth-Realm:{YourFirmId}
HTTP POST:  /staff/UDFList/{sid}
POST CONTENT:
{  
   "UDFList":[  
      {  
         "Sid":6789,
         "Value":"0"
      },
      {  
         "Sid":6790,
         "Value":"1"
      }, 
	  ...
   ]
}
HTTP RESPONSE:  (updated array of Staffer Custom Field objects -- see below for details)

Staff: Field Details

For each of the operations listed above, you will post or "get" one or more staff objects. The list below is a complete catalog of fields available through the api (including the views within which those fields are found). Take special note of the AddUpdate and Update views. Required fields are flagged with an "*" character, and fields marked with a "!" character require the ViewPersonalData permit type to view and update.

Address Object Field Details

Staffer Custom Field Object Details