The workroom/{bidId}/users method requests a report on all of the Elance members who are part of a Workroom.

The results of this method include the contractor, members of the contractor's team who have been added to the project (if any), the employer, and members of the employer's team who have been added to the project (if any).

This method must be called using an HTTPS GET request. All responses are returned in the JSON format.

I. Preconditions

This method requires that the calling application has authenticated a user with the OAuth 2.0 protocol, as described on the Getting Started page.

II. Required URL Parameters

Parameter Description
bidId The unique ID assigned by Elance to the Workroom.

III. Optional Query String Parameters

There are no optional query string parameters defined for this method.

IV. Response Data Description

Property Name Data Type Description
data Array of UserData objects An array of UserData objects (described below) describing all of the contractors or employers who belong to the Workroom.

1. UserData Object Description

Property Name Data Type Description
userId integer The unique ID, assigned by Elance, that designates the user described by this object.
companyUserId integer The unique ID, assigned by Elance, that designates the contractor or employer who created the team.
userName string The unique text string, chosen by the user, that the employer or contractor uses to log in to Elance.
displayName string The user's name.
context string Designates whether the user is a contractor or employer. Valid values are "client" (employer) and "provider" (contractor).
clientImageURL string A URL pointing to the display image that represents the employer. If this user is not an employer, this property is omitted from the response.
providerImageURL string A URL pointing to the display image that represents the contractor. If this user is not a contractor, this property is omitted from the response.

V. Request/Response Examples in JSON

1. Requesting a List of All Users in a Workroom

A. Request

The following URL requests a report of all users who belong to the Workroom designated by the bid ID 27614904.

https://api.elance.com/api2/workroom/27614904/users?access_token=4eb1de8bf06b10210e000005|3680366|_x1UCq7b7hD52jo2HLZPwQ

B. Response

{
    "data": [{
        "userId": 3680329,
        "companyUserId": 3680329,
        "userName": "testuser01",
        "displayName": "Test U.",
        "context": "provider",
        "providerImageURL": "https://elance.com/file/thumb64-80-2112337200-avatar_1.png?crypted=Y3R4JTNEc2VhcmNoX3RodW1ibmFpbCUyNmZpZCUzRDM4NDk3MzU0JTI2cmlkJTNELTElMjZwaWQlM0QzNjgwMzI5",
        "jobRole": "team leader"
    }, {
        "userId": 3680366,
        "companyUserId": 3680366,
        "userName": "employer01",
        "displayName": "John S.",
        "context": "client",
        "clientImageURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
        "jobRole": "team leader"
    }, {
        "userId": 3681181,
        "companyUserId": 3680329,
        "userName": "testuser03",
        "displayName": "Marshall E.",
        "context": "provider",
        "providerImageURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
        "jobRole": ""
    }]
}

VI. Error Codes

Error Description
E_WORKROOM_INVALID_BID Either the bidId supplied in the URL is invalid, or the currently logged in user does not have permission to access that Workroom.

For a list of additional error codes that can be thrown by this method, see Common API Error Codes.