The contractors/{userId} method retrieves detailed information for a specific contractor.

Results are returned in fixed pages of 25 records each. By default, the first page of results is returned with an initial request; additional pages are requested by issuing subsequent requests on the same search with the page query string parameter. Results must be presented to end users in the same order as returned by the Search methods. Re-ordering the results is considered a violation of the Elance Developer API Terms of Service.

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

tableofcontents_number_textPreconditions

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

tableofcontents_number_textRequired URL Parameters

Parameter Description
userId The unique numeric identifier assigned to the contractor by Elance.

tableofcontents_number_textOptional Query String Parameters

Parameter Description
page The page number of results to return, numbered beginning from 1. The default is 1. If this number is greater than the number of total pages (as expressed in the response by totalPages), the response contains zero results.
rpp The number of results requested per page. The default is 20. If more than 25 are requested, only 25 results are included in the response.

tableofcontents_number_textResponse Data Description

Property Name Data Type Description
userId integer The unique ID, assigned by Elance, that designates the user to whom this profile belongs.
userName string The unique text string, chosen by the user, that the employer or contractor uses to log in to Elance.
logoURL string The URL to the contractor's business image or personal picture.
companyName string The name of the business for which the contractor works. If the contractor is an unaffiliated individual user, this value will be the legal name of the contractor.
superUserName string The Elance username of the contractor's team manager, if the contractor belongs to a team on Elance.
hours integer The total number of hours logged by this contractor during her lifetime on Elance.
isOnTracker boolean True if the contractor has used the Tracker application to track time for hourly projects; otherwise, false.
hireDate string The date, in the format "Mon DD, YYYY", on which the contractor was hired to work for the currently logged in employer.
page integer The page number for this request.
totalPages integer The total number of pages of data available.
totalResults integer The number of AgentInformation objects available for this Workroom, across all pages.
numResults integer The number of ProjectData objects returned with this response.
projects Array of ProjectData objects A zero-based array of objects representing the projects which the currently logged in employer has awarded to the specified contractor. If the currently logged in user is not an employer, or the user has not hired the specified contractor for any jobs, this array will have no elements.

tableofcontents_number_textProjectData Object Data Description

Property Name Data Type Description
screenData ScreenData object An object containing properties that describe display data associated with the contractor. See below for a description of the properties associated with the ScreenData object.
isOnTracker boolean True if the contractor is using Tracker to capture his or her work hours on an hourly project; otherwise, false. (This property will always be false for fixed price projects.)
authorizedHours integer The number of hours that will be paid automatically using AutoPay; hours billed in excess of this value must be approved manually by the employer.
hours integer The total number of hours worked on this project by this contactor for the week.
hoursToday integer The total number of hours this contractor has devoted to this project for the current day.

tableofcontents_number_textScreenData Object Data Description

Property Name Data Type Description
timestamp timestamp ???
userId integer The unique ID assigned by Elance to the contractor on the Elance system.
userName string The display name of the contractor, as chosen by the user.
companyName string The name of the contractor's corporate identity or employer.
logoURL string A pointer to the graphic representing the contractor, such as a photo or a company logo.
numComments integer ???
bidId integer The unique ID, assigned by Elance, associated with this bid. This ID is also the unique ID of the project's Workroom, which is created for each proposal as soon as a proposal is submitted.
bidData BidData object Information on the associated Workroom identified by the bidId parameter. See below for a description of the properties returned on the BidData object.
date Date
displayTime string The current time as it is shown to the contractor on Elance.
screenIdx integer ???

tableofcontents_number_textBidData Object Data Description

Property Name Data Type Description
bidId integer The unique ID, assigned by Elance, associated with this bid. This ID is also the unique ID of the project's Workroom, which is created for each proposal as soon as a proposal is submitted.
jobId integer The unique ID of the associated job to which this Workroom is attached.
jobData JobData object The summary information for the associated job. NOTE: This is only returned by the workroom/proposal method.
jobName string The name of the associated job, as chosen by the employer when the job was posted.
userType string Specifies the role occupied by the currently logged in user in this project.
clientUserId integer The unique integer ID assigned to the employer on Elance.
clientName string The individual or corporate name of the employer.
clientImageURL string The URL resource pointer to the picture representing the employer, such as a photograph or a logo.
clientCountry string The employer's country, returned as the full name of the nation.
clientCountryCode string The alpha-2 country code for the employer's country of residence, as specified by ISO 3166-1.
clientCity string The city from which the employer conducts business.
providerUserId integer The unique ID of the contractor, as assigned by Elance.
providerUserName string The text string, chosen by the contractor, that the contractor uses to log into Elance.
providerName string The legal name of the contractor.
providerImageURL string The URL resource pointer to the picture representing the contractor, such as a photograph or a business logo.
providerCountry string The contractor's country, returned as the full name of the nation.
providerCountryCode string The alpha-2 country code for the contractor's country of residence, as specified by ISO 3166-1.
providerCity string The contractor's city of residence.
phase integer (Enumeration) A value indicating the current state of the project, such as whether it is open, in progress, or complete. See Phase Enumeration for valid values.
status string A textual representation of the current phase of the project. Used for display purposes only; the values returned for this property may change without notice.
isHourly boolean True if the contractor charges the employer for every hour worked; false if the job is fixed price, and paid according to the fulfillment of milestones agreed upon by the employer and the contractor.
isSponsored boolean True if the contractor paid additional Connect points to promote this bid in the bid listings; otherwise, false.
isPreBid boolean True if the bid represents a question from the contractor to the employer, and does not include a price quote; otherwise, false.
bidAmount decimal (JSON string) The total amount, in US dollars, that the contractor is proposing as the project cost.
hourlyRate decimal (JSON string) The amount per hour that the contractor proposes charging for this work. If the job is a fixed-price job, this property will be an empty string.
hoursPerWeek integer (JSON string) The number of hours the contractor proposes working each week until project completion.
duration integer The proposed time it will take to complete the project. This unit is either days, weeks, or months, and depends upon the desired timeframe initially selected by the employer.
submissionDate Date The month, day and year on which this proposal was submitted by the contractor to the employer.
contractEndDate string A date consist of a three-letter month, day and year in the format "Mon DD, YYYY" that specifies the day on which this job is expected to be finished, and the project marked as complete.
milestonesCount integer The number of project checkpoints or deliverables defined for this project.
milestonesCompleted integer The number of project checkpoints or deliverables that have been completed to date.

tableofcontents_number_textRequest/Response Examples in JSON

tableofcontents_number_textRequesting Contractor Information

tableofcontents_number_textRequest

The following URL requests information on the contractor whose Elance user ID is 3828695.

https://api.elance.com/api2/contractors/3828695?access_token=4eb1de8bf06b10210e000005|3828514|OJShVvvqedVk2a28BOO4fA

tableofcontents_number_textResponse

{
    "data": {
        "userid": "3828695",
        "userName": "Barnie S.",
        "logoURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
        "companyName": "Barnie Stinson",
        "superUserName": null,
        "hours": 0,
        "isOnTracker": false,
        "hireDate": "Feb 19, 2012",
        "totalResults": 1,
        "totalPages": 1,
        "page": 1,
        "numResults": 0,
        "projects": {
            "0": {
                "screenData": {
                    "timestamp": 1329673281,
                    "userId": "3828695",
                    "userName": "Barnie S.",
                    "companyName": "Barnie Stinson",
                    "logoURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
                    "numComments": 0,
                    "bidId": "28595322",
                    "bidData": {
                        "bidId": "28595322",
                        "jobId": "28595318",
                        "jobName": "More PHP Programming for Online Payment Module",
                        "userType": "CLIENT",
                        "clientUserId": "3828514",
                        "clientUserName": "employer01",
                        "clientName": "employer01",
                        "clientImageURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
                        "clientCountry": "United States",
                        "clientCountryCode": "US",
                        "clientCity": "Seattle",
                        "providerUserId": "3828695",
                        "providerUserName": "contractor02",
                        "providerName": "Barnie Stinson",
                        "providerImageURL": "https://elance.com/media/images/4.0/no-photo-64x80.jpg",
                        "providerCountry": "United States",
                        "providerCountryCode": "US",
                        "providerCity": "Seattle",
                        "phase": "5",
                        "status": "Working",
                        "isHourly": false,
                        "isSponsored": true,
                        "isPreBid": false,
                        "bidAmount": "5479.45",
                        "hourlyRate": "0",
                        "hoursPerWeek": "0",
                        "duration": "",
                        "submissionDate": 1329368400,
                        "contractEndDate": "Apr 19, 2012",
                        "milestonesCount": 1,
                        "milestonesCompleted": 0
                    },
                    "date": "19-FEB-12",
                    "displayTime": "12:41 pm",
                    "screenIdx": 3
                },
                "isOnTracker": false,
                "authorizedHours": "0",
                "hours": 0,
                "hoursToday": 0
            }
        }
    }
}

tableofcontents_number_textError Codes

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