Users

List your organisation's users

Returns all users associated with your organisation.

get/users

Request

  • Base URL: https://api.streamtime.net/v2
  • URL: https://api.streamtime.net/v2/users
  • Auth: HTTP bearer

Response

Users fetched successfully.

idinteger

User ID

emailstring email

User email address

branchIdinteger

Branch the user belongs to

roleIdinteger nullable

Role assigned to the user (if any)

displayNamestring

Display name

firstNamestring

First name

lastNamestring nullable

Last name

phoneNumberstring nullable

Primary phone number

costRatenumber float

Internal cost rate

billableRatenumber float

Billable rate for the user

hoursWorkedMondaynumber float

Hours typically worked on Monday

hoursWorkedTuesdaynumber float

Hours typically worked on Tuesday

hoursWorkedWednesdaynumber float

Hours typically worked on Wednesday

hoursWorkedThursdaynumber float

Hours typically worked on Thursday

hoursWorkedFridaynumber float

Hours typically worked on Friday

hoursWorkedSaturdaynumber float

Hours typically worked on Saturday

hoursWorkedSundaynumber float

Hours typically worked on Sunday

Example response

[
  {
    "id": 1234,
    "email": "alex.smith@example.com",
    "branchId": 123,
    "displayName": "Alex Smith",
    "firstName": "Alex",
    "lastName": "Smith",
    "phoneNumber": "+1-555-0100",
    "costRate": 45.5,
    "billableRate": 95,
    "hoursWorkedMonday": 8,
    "hoursWorkedTuesday": 8,
    "hoursWorkedWednesday": 8,
    "hoursWorkedThursday": 8,
    "hoursWorkedFriday": 8
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.