The workroom/proposals method requests the details for the winning project bid.

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
bidId The unique ID assigned by Elance to the Workroom.

tableofcontents_number_textOptional Query String Parameters

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

tableofcontents_number_textResponse Data Description

Property Name Data Type Description
data BidData object The details describing the Workroom.

tableofcontents_number_textBidData Object Data Description

Below are all of the possible properties returned as part of the BidData object. Certain API methods do not return some of these properties; these are called out on the individual API method pages.

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.
clientUserId integer The unique integer ID assigned to the employer on Elance.
clientUserName string The unique text string chosen by the employer as her Elance login.
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.
providerUserId integer The unique ID of the contractor, as assigned by Elance.
isCandidate boolean ???
providerUserName string The unique text string chosen by the contractor as her Elance login.
providerName string The legal name of the contractor.
providerCompany string The name of the contractor's business. If the contractor is a sole proprietor, this name will be equal to the value of the providerName property.
providerCompanyURL string The URL to the Web site of the contractor's business.
providerImageURL string The URL resource pointer to the picture representing the contractor, such as a photograph or a business logo.
providerProfileURL string The URL to the contractor's Elance profile.
providerJobHistoryURL string A URL linking to a page on Elance.com that displays the recent Elance jobs worked by the contractor.
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.
providerState string The contractor's state or province of residence.
providerRegion string Region where the contractor resides. For example: North America or Europe.
providerHourlyRate string The average amount that the contractor charges on an hourly basis.
providerIdVerified boolean True if the contractor has verified her identity using Elance's identity verification service; otherwise, false.
providerIsBusiness boolean True if the contractor is a legal business entity; otherwise, false.
providerWatched boolean True if the currently logged in user has this contractor on his or her watch list; otherwise, false.
providerCallable boolean True if the contractor can be contacted through the Elance voice system; otherwise, false.
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.
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.
isDeclined boolean True if the employer rejected this bid; otherwise, false.
isWithdrawn boolean True if the contractor revoked this bid after submitting it; otherwise, false.
proposalText string The original proposal as submitted by the contractor.
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 date, expressed as seconds elapsed since January 1st, 1970, on which this proposal was submitted by the contractor to the employer.
deliveryTimeline DeliveryTimeline Enumeration The expected duration of this job from the date of acceptance.
awardedDate Date The date, expressed as seconds elapsed since January 1st, 1970, on which this proposal was accepted by the employer, and the job awarded to the client.
canPostMessages boolean True if the currently logged on user have permission to send new messages to the Workroom; otherwise, false.
canHire boolean True if ???; otherwise, false.
numUnreadMessages integer The number of Workroom messages for this bid that have not yet been opened by one of the Workroom users. 
milestoneDetails Array of MilestoneDetailsData Object A zero-based array of objects describing all of the existing milestones defined for this project.

tableofcontents_number_textJobData Object Data Description

Property Data Type Description
jobId integer The unique ID of the job, as supplied in the jobId URL parameter.
userType string Specifies the role occupied by the currently logged in user in this project.
name string The one-line description given to the job by the employer.
description string A long description of the job and what it entails, as submitted by the employer.
budget string A text string representing the range of acceptable bids, as set by the employer when the job was created. This may either be a fixed price range or a range for hourly payment, depending on the job type. This string is meant for display only, and may change in future releases.
budgetMin integer (JSON string) The upper limit on project bids, as specified by the employer.
budgetMax integer (JSON string) The lower limit on project bids, as specified by the employer.
numProposals integer The number of bids and plans for project execution that have been submitted by potential contractors.
postedDate Date The month, day and year on which the job was submitted to Elance.
startDate Date The month, day and year on which the project is expected to begin.
endDate date When bidding for this job ends, in the format DD-MON-YY.
timeLeft string The number of days and hours left before the project closes to bidding. (NOTE: This is a human-readable string; the format is subject to change without notice.)
clientUserId integer The unique integer ID assigned to the employer on Elance.
clientName string The individual or corporate name of the employer.
clientUserName string The unique text string chosen by the employer as her Elance login.
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.
isHourly boolean (JSON true or false) True if the job is paid on an hourly basis; otherwise, false.
isEscrow boolean (JSON true or false) True if the Elance Escrow service is being used for payment processing; otherwise, false.
jobCatId integer (JSON string) The unique ID assigned to the job's category. A list of all current category IDs and their corresponding English names is available through the categories method.
category string The text representing the type of work represented by this project, as chosen by the employer.
subcategory string The label that further specifies the category of work to be performed.
searchURL string A URL pointing to Elance.com that displays a list of similar jobs.
recommendURL string A URL pointing to Elance.com that enables the employer to invite other Elance contractors to bid on the job.
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.
isAwarded boolean True if this project has been awarded to a contractor; otherwise, false.
numNewProposals integer The number of bids and plans for project execution submitted recently.
reasonComments string A human-readable description expanding on the current state of the project.
keepOpenAfterAward boolean True if the project remains open for other bids after the employer has selected a winning bid; otherwise, false.
reuseTerms boolean True if the contract terms were reused from another project; otherwise, false.
groupOnlyBids boolean True if the employer will only accept proposals from teams, as opposed to individual contractors; otherwise, false.
jobURL string The full path to the job listing on elance.com.

tableofcontents_number_textMilestoneDetailsData Object Data Description

Property Data Type Description
date string (Date format) The date on which this milestone will be completed, expressed in the format "MM/DD/YYYY".
description string The textual description of the milestone, as provided by the user who created the milestone.
amount string (Decimal format) The total dollar amount that the employer will pay the contractor upon completion of this milestone.
notes string Any additional description for this milestone provided by either the employer or the contractor.

tableofcontents_number_textRequest/Response Examples in JSON

tableofcontents_number_textRequesting Workroom Details

The following URL requests the Workroom details for the Workroom identified by the bid ID 30006022.

tableofcontents_number_textRequest

https://api.elance.com/api2/workroom/30006022/proposal?access_token=4eb1de8bf06b10210e000005|3680366|jA3q31erggBGhNB58Kg4kA

tableofcontents_number_textResponse

{
    "data": {
        "bidId": "30561769",
        "jobId": "30561768",
        "jobData": {
            "jobId": "30561768",
            "userType": "PROVIDER",
            "name": "PHP Development Required ASAP",
            "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "budget": " $1,000 - $5,000",
            "budgetMin": "1000",
            "budgetMax": "5000",
            "numProposals": "1",
            "postedDate": 1337659200,
            "startDate": 1337659200,
            "endDate": 1337659200,
            "timeLeft": "Closed",
            "clientUserId": "4124673",
            "clientUserName": "m_eriksen",
            "clientName": "m_eriksen",
            "clientImageURL": "https:\/\/elance.com\/media\/images\/4.0\/no-photo-64x80.jpg",
            "clientCountry": "United States",
            "clientCountryCode": "US",
            "isHourly": false,
            "isEscrow": true,
            "jobCatId": "10183",
            "category": "IT & Programming",
            "subcategory": "Web Programming",
            "searchURL": "https:\/\/elance.com\/r\/contractors\/cat-it-programming\/",
            "recommendURL": "https:\/\/elance.com\/jobInviteCandidates?jobid=30561768",
            "phase": "2",
            "isAwarded": "Y",
            "numNewProposals": "0",
            "reasonComments": "Client Closed Project. Reason: Picked Winner Early<p>",
            "keepOpenAfterAward": false,
            "reuseTerms": false,
            "groupOnlyBids": false,
            "jobURL": "https:\/\/elance.com\/j\/php-development-required-asap\/30561768\/"
        },
        "clientUserId": "4124673",
        "clientUserName": "m_eriksen",
        "clientName": "m_eriksen",
        "clientImageURL": "https:\/\/elance.com\/media\/images\/4.0\/no-photo-64x80.jpg",
        "clientCountry": "United States",
        "clientCountryCode": "US",
        "providerUserId": "4124672",
        "isCandidate": false,
        "providerUserName": "t_mosby",
        "providerName": "Ted Mosby",
        "providerCompany": "Ted Mosby",
        "providerCompanyURL": "https:\/\/elance.com\/s\/t_mosby\/",
        "providerImageURL": "https:\/\/elance.com\/media\/images\/4.0\/no-photo-64x80.jpg",
        "providerProfileURL": "https:\/\/elance.com\/s\/t_mosby\/",
        "providerJobHistoryURL": "https:\/\/elance.com\/s\/t_mosby\/job-history\/",
        "providerCountry": "United States",
        "providerCountryCode": "US",
        "providerCity": "Seattle",
        "providerState": "WA",
        "providerRegion": "021",
        "providerHourlyRate": "33",
        "providerIdVerified": false,
        "providerIsBusiness": false,
        "providerWatched": false,
        "providerCallable": false,
        "phase": "5",
        "isSponsored": false,
        "isPreBid": false,
        "isDeclined": false,
        "isWithdrawn": false,
        "proposalText": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "bidAmount": "2191.78",
        "hourlyRate": "0",
        "hoursPerWeek": "0",
        "duration": "",
        "submissionDate": 1337660280,
        "deliveryTimeline": "13012",
        "awardedDate": 1337659200,
        "canPostMessages": true,
        "canHire": false,
        "numUnreadMessages": 0,
        "milestoneDetails": {
            "0": {
                "date": "07\/22\/2012",
                "description": "Final Deliverable",
                "amount": "2191.78",
                "notes": null
            }
        }
    }
}

tableofcontents_number_textError 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.