{"_id":"57041653ecfca80e00998f76","sync_unique":"","title":"Getting Started","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[]},"settings":"","url":"","auth":"required"},"excerpt":"","slug":"getting-started","hidden":false,"isReference":false,"updates":[],"__v":1,"githubsync":"","link_url":"","parentDoc":null,"project":"57041653ecfca80e00998f70","user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","body":"Welcome to the Work Market Employer API v1 documentation. The Work Market API uses many of the same standards as other APIs you may be familiar with. All requests are simple HTTP GET or POST requests that return JSON or XML responses. (Note that the request parameters are not JSON but rather are standard HTTP keys and values EXCEPT for \"Add Workers to Talent Pool\" and \"Remove Workers from Talent Pool\".) All requests MUST use https.\n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note: For POST requests, please ensure parameters are passed in the request body, and not in the query string.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nAuthentication is done using the OAuth2 Client Credentials flow. You must include a valid access token with all requests. To generate an access token, get your API token and secret from Settings >> [API Access](https://www.workmarket.com/mmw/api), and post these to the /authorization/request endpoint (details below).\n\nThe returned access token should be included with requests via the typical *Authorization: Bearer {ACCESS_TOKEN}* header.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Structure\"\n}\n[/block]\nEvery response is contained by an envelope. That is, each response has a predictable set of keys with which you can expect to interact:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"meta\\\": {\\n        \\\"errors\\\": [],\\n        \\\"status_code\\\": 200,\\n        \\\"version\\\": 1,\\n        \\\"execution_time\\\": 0.113,\\n        \\\"timestamp\\\": 1458135792\\n    },\\n    \\\"response\\\": {\\n      ...\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response Structure\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Response Format\",\n  \"body\": \"The API will format responses in either JSON or XML.  Default is JSON.  You can request XML by passing an `output_format` parameter with value `xml`.\"\n}\n[/block]","createdAt":"2016-04-05T19:47:31.547Z","link_external":false,"category":"57041653ecfca80e00998f74","order":0,"type":"basic","next":{"description":"","pages":[]},"childrenPages":[]}

Getting Started


Welcome to the Work Market Employer API v1 documentation. The Work Market API uses many of the same standards as other APIs you may be familiar with. All requests are simple HTTP GET or POST requests that return JSON or XML responses. (Note that the request parameters are not JSON but rather are standard HTTP keys and values EXCEPT for "Add Workers to Talent Pool" and "Remove Workers from Talent Pool".) All requests MUST use https. [block:callout] { "type": "info", "body": "Note: For POST requests, please ensure parameters are passed in the request body, and not in the query string." } [/block] [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Authentication is done using the OAuth2 Client Credentials flow. You must include a valid access token with all requests. To generate an access token, get your API token and secret from Settings >> [API Access](https://www.workmarket.com/mmw/api), and post these to the /authorization/request endpoint (details below). The returned access token should be included with requests via the typical *Authorization: Bearer {ACCESS_TOKEN}* header. [block:api-header] { "type": "basic", "title": "Response Structure" } [/block] Every response is contained by an envelope. That is, each response has a predictable set of keys with which you can expect to interact: [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"errors\": [],\n \"status_code\": 200,\n \"version\": 1,\n \"execution_time\": 0.113,\n \"timestamp\": 1458135792\n },\n \"response\": {\n ...\n }\n}", "language": "json", "name": "Response Structure" } ] } [/block] [block:callout] { "type": "info", "title": "Response Format", "body": "The API will format responses in either JSON or XML. Default is JSON. You can request XML by passing an `output_format` parameter with value `xml`." } [/block]
View all 59 endpoints
Welcome to the Work Market Employer API v1 documentation. The Work Market API uses many of the same standards as other APIs you may be familiar with. All requests are simple HTTP GET or POST requests that return JSON or XML responses. (Note that the request parameters are not JSON but rather are standard HTTP keys and values EXCEPT for "Add Workers to Talent Pool" and "Remove Workers from Talent Pool".) All requests MUST use https. [block:callout] { "type": "info", "body": "Note: For POST requests, please ensure parameters are passed in the request body, and not in the query string." } [/block] [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Authentication is done using the OAuth2 Client Credentials flow. You must include a valid access token with all requests. To generate an access token, get your API token and secret from Settings >> [API Access](https://www.workmarket.com/mmw/api), and post these to the /authorization/request endpoint (details below). The returned access token should be included with requests via the typical *Authorization: Bearer {ACCESS_TOKEN}* header. [block:api-header] { "type": "basic", "title": "Response Structure" } [/block] Every response is contained by an envelope. That is, each response has a predictable set of keys with which you can expect to interact: [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"errors\": [],\n \"status_code\": 200,\n \"version\": 1,\n \"execution_time\": 0.113,\n \"timestamp\": 1458135792\n },\n \"response\": {\n ...\n }\n}", "language": "json", "name": "Response Structure" } ] } [/block] [block:callout] { "type": "info", "title": "Response Format", "body": "The API will format responses in either JSON or XML. Default is JSON. You can request XML by passing an `output_format` parameter with value `xml`." } [/block]
{"_id":"57a0a6bb0a4d6a1700f2a613","title":"Create Access Token","type":"post","order":0,"parentDoc":null,"sync_unique":"","project":"57041653ecfca80e00998f70","user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","api":{"settings":"57a27847dba9ea0e0012c8ef","url":"/authorization/request","auth":"never","examples":{"codes":[]},"method":"post","params":[{"name":"token","ref":"","required":false,"type":"string","_id":"57a0a6bb0a4d6a1700f2a615","default":"","desc":"API token found in Settings >> [API Access](https://www.workmarket.com/mmw/api)","in":"query"},{"_id":"57a0a6bb0a4d6a1700f2a614","default":"","desc":"API secret found in Settings >> [API Access](https://www.workmarket.com/mmw/api)","in":"query","name":"secret","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.016,\n    \"timestamp\": 1470157401\n  },\n  \"response\": {\n    \"access_token\": \"72ZBeC43EsCsSuTax185\"\n  }\n}","name":""}]}},"excerpt":"Create an access token for use with subsequent requests to authenticated endpoints.","githubsync":"","createdAt":"2016-08-02T13:57:15.563Z","hidden":false,"link_external":false,"updates":[],"__v":0,"category":"57a0a63bc6b7670e00db2857","slug":"get-access-token","body":"","isReference":true,"link_url":"","childrenPages":[]}

postCreate Access Token

Create an access token for use with subsequent requests to authenticated endpoints.

Query Params

token:
string
API token found in Settings >> [API Access](https://www.workmarket.com/mmw/api)
secret:
string
API secret found in Settings >> [API Access](https://www.workmarket.com/mmw/api)

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"57a23de7c0a1521900c03a2b","link_url":"","project":"57041653ecfca80e00998f70","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additional Parameters\",\n  \"body\": \"Some parameters not included here for brevity.  See [here](/v1/page/additional-assignment-creation-parameters) for details.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How to Find the Template ID\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Go to [Settings -> Templates](https://www.workmarket.com/settings/manage/templates) and find the ID in the list.  Note: there is also an [endpoint](/docs/list-4) to list all template name/ID pairs.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d3aadd0-templateid.png\",\n        \"templateid.png\",\n        976,\n        495,\n        \"#e4e8eb\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How to find the Owner ID\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Go to [View your own profile or profile of owner](https://www.workmarket.com/profile?ref=nav) and find the ID in the list\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/934a6fa-ownerid.png\",\n        \"ownerid.png\",\n        1700,\n        906,\n        \"#d7e0e1\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How to find Client ID\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Go to [Address Book -> Clients Tab](https://www.workmarket.com/addressbook) and mouseover the client. The URL in the bottom of your browser will give you the ID.  Note there is also an [endpoint](/docs/list-7) to list all clients to their names and ID. In endpoint client Id is returned under label ID not customer ID which is also returned.\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b5864a9-clientid.png\",\n        \"clientid.png\",\n        1612,\n        886,\n        \"#e0e2e3\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"How to Find Project ID\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"There is an endpoint [List Projects](doc:list-6) to get a list of projects.\",\n  \"sidebar\": true\n}\n[/block]","excerpt":"Create a new assignment.","hidden":false,"type":"post","__v":8,"githubsync":"","isReference":true,"link_external":false,"next":{"description":"","pages":[]},"parentDoc":null,"sync_unique":"","title":"Create Assignment","api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"Cache-Control: no-cache\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'access_token=YOUR_ACCESS_TOKEN_HERE&title=Work Market Test&description=Hello world!&location_address1=254 W 31st Street&location_city=New York&location_state=NY&location_zip=10011&location_country=USA&pricing_type=flat&pricing_flat_price=1000&scheduled_start_date=2016/12/31 4:30 PM&industry_id=1000&custom_field_groups[0][id]=1006&custom_field_groups[0][fields][0][id]=4380&custom_field_groups[0][fields][0][value]=Hi there' \"https://www.workmarket.com/api/v1/assignments/create\""},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/x-www-form-urlencoded\");\nRequestBody body = RequestBody.create(mediaType, \"access_token=YOUR_ACCESS_TOKEN_HERE&title=Work%20Market%20Test&description=Hello%20world!&location_address1=254%20W%2031st%20Street&location_city=New%20York&location_state=NY&location_zip=10011&location_country=USA&pricing_type=flat&pricing_flat_price=1000&scheduled_start_date=2016%2F12%2F31%204%3A30%20PM&industry_id=1000&custom_field_groups%5B0%5D%5Bid%5D=1006&custom_field_groups%5B0%5D%5Bfields%5D%5B0%5D%5Bid%5D=4380&custom_field_groups%5B0%5D%5Bfields%5D%5B0%5D%5Bvalue%5D=Hi%20there\");\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/create\")\n  .post(body)\n  .addHeader(\"content-type\", \"application/x-www-form-urlencoded\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"post","params":[{"_id":"57a23e0c851a9a0e008cbe06","ref":"","in":"body","required":false,"desc":"Template ID. Will use the assignment template and allow you to override or add additional data to the new assignment.","default":"","type":"long","name":"template_id"},{"_id":"57a240aa5220910e002a17f9","ref":"","in":"body","required":true,"desc":"Title of the assignment.","default":"","type":"string","name":"title"},{"_id":"57a240aa5220910e002a17f8","ref":"","in":"body","required":true,"desc":"Description of the assignment.","default":"","type":"string","name":"description"},{"_id":"57a240aa5220910e002a17f7","ref":"","in":"body","required":false,"desc":"More detailed instructions for the assignment.","default":"","type":"string","name":"instructions"},{"_id":"57a240aa5220910e002a17f6","ref":"","in":"body","required":false,"desc":"Flag indicating if instructions should be visible to the assigned worker only or to candidates as well.","default":"","type":"boolean","name":"private_instructions"},{"_id":"57a240aa5220910e002a17f5","ref":"","in":"body","required":false,"desc":"Skills desired in potential candidates.","default":"","type":"string","name":"desired_skills"},{"_id":"57a240aa5220910e002a17f4","ref":"","in":"body","required":true,"desc":"ID of the relevant assignment industry.  See Constants >> Industries.","default":"","type":"long","name":"industry_id"},{"_id":"57a240aa5220910e002a17f3","ref":"","in":"body","required":false,"desc":"The assignment owner's Work Market user number.","default":"","type":"long","name":"owner_id"},{"_id":"57a240aa5220910e002a17f2","ref":"","in":"body","required":false,"desc":"The assignment owner's Work Market login / email address.  Can be used instead of owner_id.","default":"","type":"string","name":"owner_email"},{"_id":"57a240aa5220910e002a17f1","ref":"","in":"body","required":false,"desc":"The support contact's Work Market user number.","default":"","type":"long","name":"support_contact_id"},{"_id":"57a240aa5220910e002a17f0","ref":"","in":"body","required":false,"desc":"The support contact's Work Market login / email address.  Can be used instead of support_contact_id.","default":"","type":"string","name":"support_contact_email"},{"_id":"57a240aa5220910e002a17ef","ref":"","in":"body","required":false,"desc":"End-client identifier, if any.","default":"","type":"string","name":"client_id"},{"_id":"57a240aa5220910e002a17ee","ref":"","in":"body","required":false,"desc":"Project ID, if any.","default":"","type":"long","name":"project_id"},{"_id":"57a240aa5220910e002a17ed","ref":"","in":"body","required":false,"desc":"Start time of an assignment in Unix time","default":"","type":"long","name":"scheduled_start"},{"_id":"57a240aa5220910e002a17ec","ref":"","in":"body","required":false,"desc":"Start time of an assignment in yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.","default":"","type":"string","name":"scheduled_start_date"},{"_id":"57a240aa5220910e002a17eb","ref":"","in":"body","required":false,"desc":"If the schedule is a range, end time of an assignment in Unix time.","default":"","type":"long","name":"scheduled_end"},{"_id":"57a240aa5220910e002a17ea","ref":"","in":"body","required":false,"desc":"If the schedule is a range, end time of an assignment in yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.","default":"","type":"string","name":"scheduled_end_date"},{"_id":"57a240aa5220910e002a17e9","ref":"","in":"body","required":false,"desc":"One of \"spend\" or \"pay\", indicating if the price should be inclusive of any platform fees (\"spend\") or exclusive (\"pay\").","default":"","type":"string","name":"pricing_mode"},{"_id":"57a240aa5220910e002a17e8","ref":"","in":"body","required":true,"desc":"One of \"flat\", \"per_hour\", \"per_unit\", \"blended_per_hour\", or \"internal\".","default":"","type":"string","name":"pricing_type"},{"_id":"57a240aa5220910e002a17e7","ref":"","in":"body","required":false,"desc":"Flat price","default":"","type":"float","name":"pricing_flat_price"},{"_id":"57a240aa5220910e002a17e6","ref":"","in":"body","required":false,"desc":"Per hour rate, when using \"per_hour\" pricing type.","default":"","type":"float","name":"pricing_per_hour_price"},{"_id":"57a240aa5220910e002a17e5","ref":"","in":"body","required":false,"desc":"Max number of budgeted hours, when using \"per_hour\" pricing type.","default":"","type":"float","name":"pricing_max_number_of_hours"},{"_id":"57a240aa5220910e002a17e4","ref":"","in":"body","required":false,"desc":"Per unit rate, when using \"per_unit\" pricing type.","default":"","type":"float","name":"pricing_per_unit_price"},{"_id":"57a27654b7d9350e00a451d3","ref":"","in":"body","required":false,"desc":"Max number of budgeted units, when using \"per_unit\" pricing type.","default":"","type":"float","name":"pricing_max_number_of_units"},{"_id":"57a27654b7d9350e00a451d2","ref":"","in":"body","required":false,"desc":"Initial per hour rate, when using \"blended_per_hour\" rate.","default":"","type":"float","name":"pricing_initial_per_hour_price"},{"_id":"57a27654b7d9350e00a451d1","ref":"","in":"body","required":false,"desc":"Max number of budgeted initial hours, when using \"blended_per_hour\" pricing type.","default":"","type":"float","name":"pricing_initial_number_of_hours"},{"_id":"57a27654b7d9350e00a451d0","ref":"","in":"body","required":false,"desc":"Rate for additional hours, when using \"blended_per_hour\" pricing type.","default":"","type":"float","name":"pricing_additional_per_hour_price"},{"_id":"57a27654b7d9350e00a451cf","ref":"","in":"body","required":false,"desc":"Max number of budgeted addtitional hours, when using \"blended_per_hour\" pricing type.","default":"","type":"float","name":"pricing_max_blended_number_of_hours"},{"_id":"57a27654b7d9350e00a451ce","ref":"","in":"body","required":false,"desc":"Flag indicating this assignment does not have a physical location.","default":"","type":"boolean","name":"location_offsite"},{"_id":"57a27654b7d9350e00a451cd","ref":"","in":"body","required":false,"desc":"By passing an id, an existing location will be associated with this assignment; if set, all other location fields are ignored.","default":"","type":"string","name":"location_id"},{"_id":"57a27654b7d9350e00a451cc","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_name"},{"_id":"57a27654b7d9350e00a451cb","ref":"","in":"body","required":false,"desc":"Custom identifier for this location","default":"","type":"string","name":"location_number"},{"_id":"57a27654b7d9350e00a451ca","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_address1"},{"_id":"57a27654b7d9350e00a451c9","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_address2"},{"_id":"57a27654b7d9350e00a451c8","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_city"},{"_id":"57a27654b7d9350e00a451c7","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_state"},{"_id":"57a27654b7d9350e00a451c6","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_zip"},{"_id":"57a27654b7d9350e00a451c5","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_country"},{"_id":"5a4eed3c361de20026b26389","ref":"","in":"body","required":false,"desc":"Note: up to two contacts can be added use [1] for second contact","default":"","type":"string","name":"location_contacts[0][first_name]"},{"_id":"5a4eed3c361de20026b26388","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_contacts[0][last_name]"},{"_id":"5a4eed3c361de20026b26387","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_contacts[0][phone]"},{"_id":"5a4eed3c361de20026b26386","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"location_contacts[0][email]"},{"_id":"5a4eed3c361de20026b26385","ref":"","in":"body","required":false,"desc":"Use if the WorkMarket Worker ID already known","default":"","type":"long","name":"location_contacts[0][id]"},{"_id":"57a27654b7d9350e00a451bc","ref":"","in":"body","required":false,"desc":"","default":"","type":"long","name":"custom_field_groups[0][id]"},{"_id":"57a27654b7d9350e00a451bb","ref":"","in":"body","required":false,"desc":"","default":"","type":"long","name":"custom_field_groups[0][fields][0][id]"},{"_id":"57a27654b7d9350e00a451ba","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"custom_field_groups[0][fields][0][value]"},{"_id":"57a27654b7d9350e00a4519c","ref":"","in":"body","required":false,"desc":"Group IDs to send to.","default":"","type":"string","name":"send_to_groups[0]"},{"_id":"57a27654b7d9350e00a4519b","ref":"","in":"body","required":false,"desc":"Group Send only. The maximum distance from the assignment location (in miles). Group workers outside this range will not be invited. Default is 60 miles, max is 100 miles.","default":"","type":"long","name":"send_radius"},{"_id":"57a27654b7d9350e00a4519a","ref":"","in":"body","required":false,"desc":"Worker ID or email address to send the assignment to. No distance filter is applied. Note: you can pass in multiple resource_id=x parameters. This does not use the resource_id[N] notation that some other fields use.","default":"","type":"long","name":"resource_id"},{"_id":"57a27654b7d9350e00a45199","ref":"","in":"body","required":false,"desc":"Automatically determine the best workers for your assignment and send to them.","default":"","type":"boolean","name":"auto_invite"},{"_id":"5925b92b3b8c27250014c486","ref":"","in":"body","required":false,"desc":"Indicates if recipients of the assignment should be able to accept the assignment outright or must apply first.","default":"","type":"boolean","name":"assign_to_first_to_accept"},{"_id":"5925b92b3b8c27250014c485","ref":"","in":"body","required":false,"desc":"When true, the assignment is posted to the WorkFeed","default":"","type":"boolean","name":"show_in_work_feed"},{"_id":"594404aa280bcc0039c05c38","ref":"","in":"body","required":false,"desc":"Payment terms duration in days for this assignment","default":"","type":"long","name":"payment_terms_days"}],"results":{"codes":[{"status":200,"code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.705,\n    \"timestamp\": 1470265773\n  },\n  \"response\": {\n    \"id\": \"3494635296\"\n  }\n}","language":"json"}]},"settings":"","url":"/assignments/create","auth":"required"},"createdAt":"2016-08-03T18:54:31.542Z","updates":[],"user":"57041635473f900e004d5a35","order":0,"slug":"create","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","childrenPages":[]}

postCreate Assignment

Create a new assignment.

Body Params

template_id:
long
Template ID. Will use the assignment template and allow you to override or add additional data to the new assignment.
title:
required
string
Title of the assignment.
description:
required
string
Description of the assignment.
instructions:
string
More detailed instructions for the assignment.
private_instructions:
boolean
Flag indicating if instructions should be visible to the assigned worker only or to candidates as well.
desired_skills:
string
Skills desired in potential candidates.
industry_id:
required
long
ID of the relevant assignment industry. See Constants >> Industries.
owner_id:
long
The assignment owner's Work Market user number.
owner_email:
string
The assignment owner's Work Market login / email address. Can be used instead of owner_id.
support_contact_id:
long
The support contact's Work Market user number.
support_contact_email:
string
The support contact's Work Market login / email address. Can be used instead of support_contact_id.
client_id:
string
End-client identifier, if any.
project_id:
long
Project ID, if any.
scheduled_start:
long
Start time of an assignment in Unix time
scheduled_start_date:
string
Start time of an assignment in yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.
scheduled_end:
long
If the schedule is a range, end time of an assignment in Unix time.
scheduled_end_date:
string
If the schedule is a range, end time of an assignment in yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.
pricing_mode:
string
One of "spend" or "pay", indicating if the price should be inclusive of any platform fees ("spend") or exclusive ("pay").
pricing_type:
required
string
One of "flat", "per_hour", "per_unit", "blended_per_hour", or "internal".
pricing_flat_price:
float
Flat price
pricing_per_hour_price:
float
Per hour rate, when using "per_hour" pricing type.
pricing_max_number_of_hours:
float
Max number of budgeted hours, when using "per_hour" pricing type.
pricing_per_unit_price:
float
Per unit rate, when using "per_unit" pricing type.
pricing_max_number_of_units:
float
Max number of budgeted units, when using "per_unit" pricing type.
pricing_initial_per_hour_price:
float
Initial per hour rate, when using "blended_per_hour" rate.
pricing_initial_number_of_hours:
float
Max number of budgeted initial hours, when using "blended_per_hour" pricing type.
pricing_additional_per_hour_price:
float
Rate for additional hours, when using "blended_per_hour" pricing type.
pricing_max_blended_number_of_hours:
float
Max number of budgeted addtitional hours, when using "blended_per_hour" pricing type.
location_offsite:
boolean
Flag indicating this assignment does not have a physical location.
location_id:
string
By passing an id, an existing location will be associated with this assignment; if set, all other location fields are ignored.
location_name:
string
location_number:
string
Custom identifier for this location
location_address1:
string
location_address2:
string
location_city:
string
location_state:
string
location_zip:
string
location_country:
string
location_contacts[0][first_name]:
string
Note: up to two contacts can be added use [1] for second contact
location_contacts[0][last_name]:
string
location_contacts[0][phone]:
string
location_contacts[0][email]:
string
location_contacts[0][id]:
long
Use if the WorkMarket Worker ID already known
custom_field_groups[0][id]:
long
custom_field_groups[0][fields][0][id]:
long
custom_field_groups[0][fields][0][value]:
string
send_to_groups[0]:
string
Group IDs to send to.
send_radius:
long
Group Send only. The maximum distance from the assignment location (in miles). Group workers outside this range will not be invited. Default is 60 miles, max is 100 miles.
resource_id:
long
Worker ID or email address to send the assignment to. No distance filter is applied. Note: you can pass in multiple resource_id=x parameters. This does not use the resource_id[N] notation that some other fields use.
auto_invite:
boolean
Automatically determine the best workers for your assignment and send to them.
assign_to_first_to_accept:
boolean
Indicates if recipients of the assignment should be able to accept the assignment outright or must apply first.
show_in_work_feed:
boolean
When true, the assignment is posted to the WorkFeed
payment_terms_days:
long
Payment terms duration in days for this assignment
[block:callout] { "type": "info", "title": "Additional Parameters", "body": "Some parameters not included here for brevity. See [here](/v1/page/additional-assignment-creation-parameters) for details." } [/block] [block:api-header] { "type": "basic", "title": "How to Find the Template ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [Settings -> Templates](https://www.workmarket.com/settings/manage/templates) and find the ID in the list. Note: there is also an [endpoint](/docs/list-4) to list all template name/ID pairs.", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/d3aadd0-templateid.png", "templateid.png", 976, 495, "#e4e8eb" ] } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "How to find the Owner ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [View your own profile or profile of owner](https://www.workmarket.com/profile?ref=nav) and find the ID in the list", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/934a6fa-ownerid.png", "ownerid.png", 1700, 906, "#d7e0e1" ] } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "How to find Client ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [Address Book -> Clients Tab](https://www.workmarket.com/addressbook) and mouseover the client. The URL in the bottom of your browser will give you the ID. Note there is also an [endpoint](/docs/list-7) to list all clients to their names and ID. In endpoint client Id is returned under label ID not customer ID which is also returned.", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/b5864a9-clientid.png", "clientid.png", 1612, 886, "#e0e2e3" ] } ], "sidebar": true } [/block] [block:api-header] { "title": "How to Find Project ID", "sidebar": true } [/block] [block:textarea] { "text": "There is an endpoint [List Projects](doc:list-6) to get a list of projects.", "sidebar": true } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Additional Parameters", "body": "Some parameters not included here for brevity. See [here](/v1/page/additional-assignment-creation-parameters) for details." } [/block] [block:api-header] { "type": "basic", "title": "How to Find the Template ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [Settings -> Templates](https://www.workmarket.com/settings/manage/templates) and find the ID in the list. Note: there is also an [endpoint](/docs/list-4) to list all template name/ID pairs.", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/d3aadd0-templateid.png", "templateid.png", 976, 495, "#e4e8eb" ] } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "How to find the Owner ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [View your own profile or profile of owner](https://www.workmarket.com/profile?ref=nav) and find the ID in the list", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/934a6fa-ownerid.png", "ownerid.png", 1700, 906, "#d7e0e1" ] } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "How to find Client ID", "sidebar": true } [/block] [block:textarea] { "text": "Go to [Address Book -> Clients Tab](https://www.workmarket.com/addressbook) and mouseover the client. The URL in the bottom of your browser will give you the ID. Note there is also an [endpoint](/docs/list-7) to list all clients to their names and ID. In endpoint client Id is returned under label ID not customer ID which is also returned.", "sidebar": true } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/b5864a9-clientid.png", "clientid.png", 1612, 886, "#e0e2e3" ] } ], "sidebar": true } [/block] [block:api-header] { "title": "How to Find Project ID", "sidebar": true } [/block] [block:textarea] { "text": "There is an endpoint [List Projects](doc:list-6) to get a list of projects.", "sidebar": true } [/block]
{"_id":"57a23da15220910e002a17da","createdAt":"2016-08-03T18:53:21.431Z","excerpt":"Edit an assignment currently in *DRAFT* or *SENT* status only.\n\n*Note*: the parameters for this endpoint are the same as for the Create endpoint.","hidden":false,"type":"post","version":"57041653ecfca80e00998f73","api":{"params":[{"type":"long","name":"id","_id":"57a23dd2d778850e0047e3df","ref":"","in":"path","required":true,"desc":"The assignment identifier number.","default":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":"57a27847dba9ea0e0012c8ef","url":"/assignments/:id/edit","auth":"required","examples":{"codes":[]},"method":"post"},"category":"57a0a705c809e00e00df9cb5","project":"57041653ecfca80e00998f70","slug":"edit","githubsync":"","isReference":true,"link_external":false,"order":1,"parentDoc":null,"updates":[],"__v":1,"body":"","link_url":"","sync_unique":"","title":"Edit Assignment","user":"57041635473f900e004d5a35","childrenPages":[]}

postEdit Assignment

Edit an assignment currently in *DRAFT* or *SENT* status only. *Note*: the parameters for this endpoint are the same as for the Create endpoint.

Path Params

id:
required
long
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a0a7f47b79ae190014a4a9","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.077,\n    \"timestamp\": 1470178119\n  },\n  \"response\": {\n    \"total_results\": 435,\n    \"count\": 1,\n    \"start\": 0,\n    \"limit\": 1,\n    \"data\": [\n      {\n        \"id\": \"1140378203\",\n        \"project_id\": null,\n        \"title\": \"Work Market API Demo\",\n        \"scheduled_start\": 1387690200,\n        \"scheduled_end\": null,\n        \"city\": \"Orlando\",\n        \"state\": \"FL\",\n        \"postal_code\": \"32836\",\n        \"location_id\": null,\n        \"spend_limit\": \"50.00\",\n        \"modified_status\": \"Draft\",\n        \"status\": \"draft\",\n        \"substatuses\": [],\n        \"labels\": [],\n        \"internal_owner\": \"Stephan Newhouse\",\n        \"client\": null,\n        \"client_id\": null,\n        \"paid_date\": null,\n        \"total_cost\": \"0.0\",\n        \"resource_company_name\": null,\n        \"resource_user_number\": null,\n        \"resource_full_name\": null,\n        \"last_modified_on\": 1373900494,\n        \"modifier_first_name\": \"S\",\n        \"modifier_last_name\": \"Newhouse\"\n      }\n    ]\n  }\n}","name":""}]},"settings":"","url":"/assignments/list","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" \"https://www.workmarket.com/api/v1/assignments/list?status=inprogress&labels&client_id&limit=50\""},{"code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/list?status=inprogress&labels=&client_id=&limit=50\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer YOUR_ACCESS_TOKEN_HERE\")\n  .build();\n\nResponse response = client.newCall(request).execute();","language":"java"}]},"method":"get","params":[{"ref":"","required":false,"type":"string","_id":"57a0a7f47b79ae190014a4ae","default":"","desc":"Assignment status filter. Default is 'inprogress'.","in":"query","name":"status"},{"ref":"","required":false,"type":"string","_id":"57a0a7f47b79ae190014a4ad","default":"","desc":"Label IDs to filter on, comma separated.","in":"query","name":"labels"},{"desc":"Client ID to filter on.","in":"query","name":"client_id","ref":"","required":false,"type":"string","_id":"57a0a7f47b79ae190014a4ac","default":""},{"in":"query","name":"start","ref":"","required":false,"type":"string","_id":"57a0a7f47b79ae190014a4ab","default":"","desc":"Index at which to begin the listing."},{"required":false,"type":"string","_id":"57a0a7f47b79ae190014a4aa","default":"","desc":"Number of results to include in a query. Maximum 50.","in":"query","name":"limit","ref":""}]},"createdAt":"2016-08-02T14:02:28.674Z","excerpt":"List assignments by status, client, or label. Filters are compounded.  See [here](/page/labels) for more on labels.","hidden":false,"isReference":true,"project":"57041653ecfca80e00998f70","type":"get","__v":0,"body":"","githubsync":"","link_url":"","order":2,"updates":[],"version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","slug":"list","title":"List Assignments","link_external":false,"parentDoc":null,"sync_unique":"","user":"57041635473f900e004d5a35","childrenPages":[]}

getList Assignments

List assignments by status, client, or label. Filters are compounded. See [here](/page/labels) for more on labels.

Query Params

status:
string
Assignment status filter. Default is 'inprogress'.
labels:
string
Label IDs to filter on, comma separated.
client_id:
string
Client ID to filter on.
start:
string
Index at which to begin the listing.
limit:
string
Number of results to include in a query. Maximum 50.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"57a125b3e80f940e00c46f07","isReference":true,"parentDoc":null,"slug":"list-updated","title":"List Updated Assignments","api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" \"https://www.workmarket.com/api/v1/assignments/list_updated?status=inprogress&modified_since&labels&client_id&limit=50\""},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/list_updated?status=draft&modified_since=&labels=&client_id=&limit=50\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer YOUR_ACCESS_TOKEN_HERE\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"type":"string","_id":"57a0a7f47b79ae190014a4ae","default":"inprogress","desc":"Assignment status filter. Default is 'inprogress'.","in":"query","name":"status","ref":"","required":false},{"required":true,"type":"long","_id":"57a125b3e80f940e00c46f08","default":"","desc":"A timestamp to query for data since time X (Unix Time in seconds).","in":"query","name":"modified_since","ref":""},{"required":false,"desc":"Label IDs to filter on, comma separated.","default":"","type":"string","name":"labels","_id":"57a0a7f47b79ae190014a4ad","ref":"","in":"query"},{"ref":"","in":"query","required":false,"desc":"Client ID to filter on.","default":"","type":"string","name":"client_id","_id":"57a0a7f47b79ae190014a4ac"},{"in":"query","required":false,"desc":"Index at which to begin the listing.","default":"","type":"string","name":"start","_id":"57a0a7f47b79ae190014a4ab","ref":""},{"default":"","type":"string","name":"limit","_id":"57a0a7f47b79ae190014a4aa","ref":"","in":"query","required":false,"desc":"Number of results to include in a query. Maximum 50."}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.077,\n    \"timestamp\": 1470178119\n  },\n  \"response\": {\n    \"total_results\": 435,\n    \"count\": 1,\n    \"start\": 0,\n    \"limit\": 1,\n    \"data\": [\n      {\n        \"id\": \"1140378203\",\n        \"project_id\": null,\n        \"title\": \"Work Market API Demo\",\n        \"scheduled_start\": 1387690200,\n        \"scheduled_end\": null,\n        \"city\": \"Orlando\",\n        \"state\": \"FL\",\n        \"postal_code\": \"32836\",\n        \"location_id\": null,\n        \"spend_limit\": \"50.00\",\n        \"modified_status\": \"Draft\",\n        \"status\": \"draft\",\n        \"substatuses\": [],\n        \"labels\": [],\n        \"internal_owner\": \"Stephan Newhouse\",\n        \"client\": null,\n        \"client_id\": null,\n        \"paid_date\": null,\n        \"total_cost\": \"0.0\",\n        \"resource_company_name\": null,\n        \"resource_user_number\": null,\n        \"resource_full_name\": null,\n        \"last_modified_on\": 1373900494,\n        \"modifier_first_name\": \"S\",\n        \"modifier_last_name\": \"Newhouse\"\n      }\n    ]\n  }\n}","name":""}]},"settings":"","url":"/assignments/list_updated","auth":"required"},"body":"","category":"57a0a705c809e00e00df9cb5","sync_unique":"","updates":[],"user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","createdAt":"2016-08-02T22:58:59.396Z","hidden":false,"type":"get","githubsync":"","link_url":"","project":"57041653ecfca80e00998f70","order":3,"__v":0,"excerpt":"List assignments modified after the provided timestamp. Supports status, label, and client filters. Filters are compounded.  See [here](/page/labels) for more on labels.","link_external":false,"childrenPages":[]}

getList Updated Assignments

List assignments modified after the provided timestamp. Supports status, label, and client filters. Filters are compounded. See [here](/page/labels) for more on labels.

Query Params

status:
stringinprogress
Assignment status filter. Default is 'inprogress'.
modified_since:
required
long
A timestamp to query for data since time X (Unix Time in seconds).
labels:
string
Label IDs to filter on, comma separated.
client_id:
string
Client ID to filter on.
start:
string
Index at which to begin the listing.
limit:
string
Number of results to include in a query. Maximum 50.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"57a0a82319a5850e0096aa2f","isReference":true,"link_external":false,"project":"57041653ecfca80e00998f70","user":"57041635473f900e004d5a35","__v":2,"excerpt":"Fetch the details of a single assignment.","order":4,"parentDoc":null,"title":"Get Assignment","updates":[],"body":"","category":"57a0a705c809e00e00df9cb5","githubsync":"","sync_unique":"","version":"57041653ecfca80e00998f73","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" -H \"Cache-Control: no-cache\" \"https://www.workmarket.com/api/v1/assignments/get?id=ASSIGNMENT_ID\""},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/get?id=ASSIGNMENT_ID\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer YOUR_ACCESS_TOKEN_HERE\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"_id":"57a0a82319a5850e0096aa30","ref":"","in":"query","required":false,"desc":"Assignment ID to get","default":"","type":"long","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.184,\n    \"timestamp\": 1470177842\n  },\n  \"response\": {\n    \"id\": \"8014976123\",\n    \"title\": \"Work Market Test\",\n    \"description\": \"Hello world!\",\n    \"instructions\": null,\n    \"desired_skills\": null,\n    \"short_url\": \"http://goo.gl/LzvP0F\",\n    \"status\": \"draft\",\n    \"substatuses\": null,\n    \"labels\": null,\n    \"project\": null,\n    \"client\": null,\n    \"internal_owner\": \"3437754\",\n    \"assignment_window_start\": 1483219800,\n    \"assignment_window_start_date\": \"Sat Dec 31 21:30:00 UTC 2016\",\n    \"assignment_window_end\": null,\n    \"assignment_window_end_date\": \"Sat Dec 31 21:30:00 UTC 2016\",\n    \"scheduled_start\": 1483219800,\n    \"scheduled_end\": null,\n    \"resolution\": null,\n    \"industry\": \"Technology and Communications\",\n    \"time_zone\": \"America/New_York\",\n    \"required_attachments\": 0,\n    \"location\": {\n      \"id\": 296543,\n      \"name\": \"\",\n      \"location_number\": null,\n      \"address_1\": \"254 W 31st Street\",\n      \"address_2\": null,\n      \"city\": \"New York\",\n      \"state\": \"NY\",\n      \"zip\": \"10011\",\n      \"country\": \"USA\",\n      \"latitude\": \"40.740256\",\n      \"longitude\": \"-73.992391\"\n    },\n    \"location_offsite\": false,\n    \"location_contact\": null,\n    \"support_contact\": null,\n    \"active_resource\": null,\n    \"pricing\": {\n      \"type\": \"FLAT FEE\",\n      \"spend_limit\": 100,\n      \"budget_increases\": \"0.0\",\n      \"expense_reimbursements\": 0,\n      \"bonuses\": 0,\n      \"additional_expenses\": 0,\n      \"flat_price\": 100\n    },\n    \"payment\": {\n      \"max_spend_limit\": 100,\n      \"actual_spend_limit\": 0,\n      \"buyer_fee\": 10,\n      \"total_cost\": 110,\n      \"hours_worked\": 0,\n      \"paid_on\": 0,\n      \"payment_due_on\": 0\n    },\n    \"attachments\": [],\n    \"created_on\": 1470177836,\n    \"last_modified_on\": 1470177836,\n    \"history\": [\n      {\n        \"date\": 1470177836,\n        \"text\": \"Assignment created by API API\"\n      }\n    ],\n    \"notes\": [],\n    \"custom_fields\": [\n      {\n        \"id\": 996,\n        \"name\": \"UPYPDXBWYT\",\n        \"fields\": [\n          {\n            \"id\": 4130,\n            \"name\": \"MXVRIUNANP\",\n            \"default\": \"ZAANYISTVD\",\n            \"required\": false,\n            \"value\": \"ZAANYISTVD\"\n          },\n          {\n            \"id\": 4131,\n            \"name\": \"OJIZXLNGZR\",\n            \"default\": \"\",\n            \"required\": false,\n            \"value\": \"\"\n          }\n        ]\n      }\n    ],\n    \"parts\": null,\n    \"pending_offers\": [\n      {\n        \"id\": 17737937,\n        \"note\": \"I'll do it!\",\n        \"resource\": {\n          \"id\": \"46787255\",\n          \"first_name\": \"Abe\",\n          \"last_name\": \"Johannson\",\n          \"email\": \"w.o.r.k.m.arketdemo@gmail.com\",\n          \"company_name\": \"Abe Visual\",\n          \"rating\": 96.61,\n          \"number_of_ratings\": 74,\n          \"job_title\": null,\n          \"overview\": \"I have a great range of skills\",\n          \"phone_numbers\": [\n            {\n              \"country_code\": \"1\",\n              \"phone\": \"5555555555\",\n              \"type\": \"WORK\",\n              \"extension\": null,\n              \"number\": \"5555555555\"\n            }\n          ]\n       },\n    ],\n    \"declined_resources\": [],\n    \"questions\": []\n  }\n}","name":""}]},"settings":"","url":"/assignments/get"},"link_url":"","slug":"get","createdAt":"2016-08-02T14:03:15.588Z","hidden":false,"type":"get","next":{"description":"","pages":[]},"childrenPages":[]}

getGet Assignment

Fetch the details of a single assignment.

Query Params

id:
long
Assignment ID to get

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"57a22ba6cd51b22d00f623a1","body":"","createdAt":"2016-08-03T17:36:38.496Z","hidden":false,"link_url":"","title":"Delete Assignment","type":"post","project":"57041653ecfca80e00998f70","__v":1,"api":{"params":[{"ref":"","in":"body","required":true,"desc":"","default":"The assignment identifier number.","type":"long","name":"id","_id":"57a22c8ecd51b22d00f62435"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/delete","auth":"required","examples":{"codes":[]},"method":"post"},"category":"57a0a705c809e00e00df9cb5","link_external":false,"parentDoc":null,"slug":"delete","user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","excerpt":"Delete an assignment. Note: only assignments in 'Draft' status can be deleted. Use 'void' for 'Draft' or 'Sent' assignments, and 'cancel' for 'Assigned'/'In Progress' assignments.","githubsync":"","isReference":true,"order":5,"sync_unique":"","updates":[],"childrenPages":[]}

postDelete Assignment

Delete an assignment. Note: only assignments in 'Draft' status can be deleted. Use 'void' for 'Draft' or 'Sent' assignments, and 'cancel' for 'Assigned'/'In Progress' assignments.

Body Params

id:
required
longThe assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22928f724ae1900df4943","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","createdAt":"2016-08-03T17:26:00.597Z","hidden":false,"isReference":true,"type":"post","user":"57041635473f900e004d5a35","__v":3,"next":{"description":"","pages":[]},"order":6,"parentDoc":null,"slug":"a","sync_unique":"","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" -H \"Cache-Control: no-cache\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'resource_id=bob@domain.com' \"https://www.workmarket.com/api/v1/assignments/3383087231/send\""}]},"method":"post","params":[{"_id":"57a2299fcd51b22d00f6239a","ref":"","in":"path","required":false,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a2299fcd51b22d00f62399","ref":"","in":"body","required":false,"desc":"Worker ID or email address to send the assignment to. No distance filter is applied. You can specify multiple worker IDs by passing in more than 1 resource_id=x parameter.","default":"","type":"string","name":"resource_id"},{"_id":"57a2299fcd51b22d00f62398","ref":"","in":"body","required":false,"desc":"The group ID to send to. You can specify multiple groups by passing in more than 1 group_id=x parameter.","default":"","type":"long","name":"group_id"},{"_id":"57a2299fcd51b22d00f62397","ref":"","in":"body","required":false,"desc":"The maximum distance from the assignment location (in miles). Group workers outside this range will not be invited. Default is 60 miles, max is 100 miles","default":"60","type":"int","name":"send_radius"},{"_id":"5925b993dd71b51b00ccc2f4","ref":"","in":"body","required":false,"desc":"Indicates if recipients of the assignment should be able to accept the assignment outright or must apply first.","default":"","type":"boolean","name":"assign_to_first_to_accept"},{"_id":"5925b993dd71b51b00ccc2f3","ref":"","in":"body","required":false,"desc":"Automatically determine the best workers for your assignment and send to them.","default":"false","type":"boolean","name":"auto_invite"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/:id/send"},"excerpt":"Sends the assignment to the specified talent pool (aka group) and/or worker IDs.  Alternatively, use auto-invite to automatically determine the best workers for your assignment.","link_external":false,"link_url":"","title":"Send Assignment","body":"","githubsync":"","project":"57041653ecfca80e00998f70","updates":[],"childrenPages":[]}

postSend Assignment

Sends the assignment to the specified talent pool (aka group) and/or worker IDs. Alternatively, use auto-invite to automatically determine the best workers for your assignment.

Path Params

id:
long
The assignment identifier number.

Body Params

resource_id:
string
Worker ID or email address to send the assignment to. No distance filter is applied. You can specify multiple worker IDs by passing in more than 1 resource_id=x parameter.
group_id:
long
The group ID to send to. You can specify multiple groups by passing in more than 1 group_id=x parameter.
send_radius:
integer60
The maximum distance from the assignment location (in miles). Group workers outside this range will not be invited. Default is 60 miles, max is 100 miles
assign_to_first_to_accept:
boolean
Indicates if recipients of the assignment should be able to accept the assignment outright or must apply first.
auto_invite:
booleanfalse
Automatically determine the best workers for your assignment and send to them.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"57a22bb3afc3050e000cf404","api":{"method":"post","params":[{"required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a22c74d778850e0047e3a1","ref":"","in":"body"},{"ref":"","in":"body","required":true,"desc":"Amount to pay worker","default":"","type":"int","name":"amount","_id":"57a22d9b5220910e002a178d"},{"in":"body","required":false,"desc":"Reason for the cancellation.","default":"","type":"string","name":"reason","_id":"57a22d9b5220910e002a178c","ref":""},{"desc":"This is the note content, visible to the worker.","default":"","type":"string","name":"note","_id":"57a22d9b5220910e002a178b","ref":"","in":"body","required":false}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/cancel","auth":"required","examples":{"codes":[]}},"slug":"cancel","updates":[],"createdAt":"2016-08-03T17:36:51.024Z","hidden":false,"version":"57041653ecfca80e00998f73","__v":2,"excerpt":"Cancel an assignment. Note: only assignments that are currently 'Active' or 'In Progress' can be cancelled. Use 'delete' or 'void' for 'Draft', or 'void' for 'Sent' assignments.","isReference":true,"link_url":"","project":"57041653ecfca80e00998f70","sync_unique":"","user":"57041635473f900e004d5a35","body":"","category":"57a0a705c809e00e00df9cb5","githubsync":"","link_external":false,"order":7,"parentDoc":null,"title":"Cancel Assignment","type":"post","childrenPages":[]}

postCancel Assignment

Cancel an assignment. Note: only assignments that are currently 'Active' or 'In Progress' can be cancelled. Use 'delete' or 'void' for 'Draft', or 'void' for 'Sent' assignments.

Body Params

id:
required
long
The assignment identifier number.
amount:
required
integer
Amount to pay worker
reason:
string
Reason for the cancellation.
note:
string
This is the note content, visible to the worker.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22dafcd51b22d00f62436","createdAt":"2016-08-03T17:45:19.077Z","body":"","category":"57a0a705c809e00e00df9cb5","order":8,"project":"57041653ecfca80e00998f70","title":"Void Assignment","version":"57041653ecfca80e00998f73","excerpt":"Void an assignment. Note: only assignments that are currently in 'Draft' or 'Sent' status can be voided. Use 'cancel' for 'Assigned' or 'In Progress' assignments.","isReference":true,"hidden":false,"link_external":false,"slug":"void","githubsync":"","link_url":"","parentDoc":null,"sync_unique":"","type":"post","updates":[],"user":"57041635473f900e004d5a35","__v":0,"api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a22c74d778850e0047e3a1","ref":"","in":"body","required":true},{"_id":"57a22d9b5220910e002a178b","ref":"","in":"body","required":false,"desc":"This is the note content, visible to the worker.","default":"","type":"string","name":"note"}],"results":{"codes":[{"code":"","language":"text"}]},"settings":"","url":"/assignments/void"},"childrenPages":[]}

postVoid Assignment

Void an assignment. Note: only assignments that are currently in 'Draft' or 'Sent' status can be voided. Use 'cancel' for 'Assigned' or 'In Progress' assignments.

Body Params

id:
required
long
The assignment identifier number.
note:
string
This is the note content, visible to the worker.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5a7b8443770d5e0012198f14","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-07T22:57:07.232Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a22e89cd51b22d00f6243e","ref":"","in":"body","required":true,"desc":"Valid values are \"resource_abandoned\" and \"resource_cancelled\"","default":"","type":"string","name":"cancellation_reason"},{"_id":"5a7b4923724509001c038285","ref":"","in":"body","required":true,"desc":"Indicates whether assignment should rollback to original price or should remain as the price negotiated with the worker you're unassigning","default":"","type":"boolean","name":"rollback_to_original_price"},{"_id":"5a7b4923724509001c038284","ref":"","in":"body","required":true,"desc":"Note explaining to the worker why he or she is being unassigned","default":"","type":"string","name":"note"}],"url":"/assignments/:id/unassign"},"isReference":true,"order":9,"body":"","excerpt":"Remove an assigned worker from an active assignment. Assignment cannot be invoiced.","slug":"unassign-worker","type":"post","title":"Unassign Worker","__v":4,"parentDoc":null,"childrenPages":[]}

postUnassign Worker

Remove an assigned worker from an active assignment. Assignment cannot be invoiced.

Path Params

id:
required
long
The assignment identifier number.

Body Params

cancellation_reason:
required
string
Valid values are "resource_abandoned" and "resource_cancelled"
rollback_to_original_price:
required
boolean
Indicates whether assignment should rollback to original price or should remain as the price negotiated with the worker you're unassigning
note:
required
string
Note explaining to the worker why he or she is being unassigned

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5a7b4923724509001c038283","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-07T18:44:51.006Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a22e89cd51b22d00f6243e","ref":"","in":"body","required":false,"desc":"If updating an existing check-in/check-out pair, the identifier of that pair.","default":"","type":"long","name":"check_in_out_id"},{"_id":"5a7b4923724509001c038285","ref":"","in":"body","required":false,"desc":"A comment to accompany the check-in.","default":"","type":"string","name":"note"},{"_id":"5a7b4923724509001c038284","ref":"","in":"body","required":true,"desc":"Check-in time. Must be in the past. When updating an existing check-in/check-out pair, must be prior to a check-out time if one is present. yyyy-MM-dd HH:mm:ss format.","default":"","type":"string","name":"datetime"}],"url":"/:id/update_checkin"},"isReference":true,"order":10,"body":"","excerpt":"Check-in (new) or update an existing check-in from a check-in/check-out pair on behalf of an assigned worker.","slug":"check-in-to-assignment-on-behalf-of-worker","type":"post","title":"Check-in to Assignment (on behalf of worker)","__v":4,"parentDoc":null,"childrenPages":[]}

postCheck-in to Assignment (on behalf of worker)

Check-in (new) or update an existing check-in from a check-in/check-out pair on behalf of an assigned worker.

Path Params

id:
required
long
The assignment identifier number.

Body Params

check_in_out_id:
long
If updating an existing check-in/check-out pair, the identifier of that pair.
note:
string
A comment to accompany the check-in.
datetime:
required
string
Check-in time. Must be in the past. When updating an existing check-in/check-out pair, must be prior to a check-out time if one is present. yyyy-MM-dd HH:mm:ss format.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5a7b4981c5400800129f86a4","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-07T18:46:25.286Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[]},"auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a22e89cd51b22d00f6243e","ref":"","in":"body","required":false,"desc":"If updating an existing check-in/check-out pair, the identifier of that pair.","default":"","type":"long","name":"check_in_out_id"},{"_id":"5a7b4923724509001c038285","ref":"","in":"body","required":false,"desc":"A comment to accompany the check-out.","default":"","type":"string","name":"note"},{"_id":"5a7b4923724509001c038284","ref":"","in":"body","required":true,"desc":"Check-out time. Must be in the past. Check-in cannot be null. Must be after check-in time. yyyy-MM-dd HH:mm:ss format.","default":"","type":"string","name":"datetime"}],"url":"/:id/update_checkout"},"isReference":true,"order":11,"body":"","excerpt":"Check-out (new) or update an existing check-out from a check-in/check-out pair on behalf of an assigned worker.","slug":"check-out-of-assignment-on-behalf-of-worker","type":"post","title":"Check-out of Assignment (on behalf of worker)","__v":4,"parentDoc":null,"childrenPages":[]}

postCheck-out of Assignment (on behalf of worker)

Check-out (new) or update an existing check-out from a check-in/check-out pair on behalf of an assigned worker.

Path Params

id:
required
long
The assignment identifier number.

Body Params

check_in_out_id:
long
If updating an existing check-in/check-out pair, the identifier of that pair.
note:
string
A comment to accompany the check-out.
datetime:
required
string
Check-out time. Must be in the past. Check-in cannot be null. Must be after check-in time. yyyy-MM-dd HH:mm:ss format.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a231d8f724ae1900df495a","hidden":false,"link_external":false,"project":"57041653ecfca80e00998f70","sync_unique":"","type":"post","githubsync":"","link_url":"","title":"Answer Question","version":"57041653ecfca80e00998f73","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"ref":"","in":"body","required":true,"desc":"The question ID.","default":"","type":"long","name":"id","_id":"57a23201d778850e0047e3ae"},{"default":"","type":"string","name":"answer","_id":"57a23201d778850e0047e3ad","ref":"","in":"body","required":true,"desc":"The answer content."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/questions/answer"},"order":12,"parentDoc":null,"slug":"answer-question","excerpt":"Answer a question on an assignment.","body":"","category":"57a0a705c809e00e00df9cb5","createdAt":"2016-08-03T18:03:04.752Z","isReference":true,"updates":[],"user":"57041635473f900e004d5a35","__v":1,"childrenPages":[]}

postAnswer Question

Answer a question on an assignment.

Body Params

id:
required
long
The question ID.
answer:
required
string
The answer content.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a234b75220910e002a17a1","createdAt":"2016-08-03T18:15:19.503Z","hidden":false,"sync_unique":"","updates":[],"version":"57041653ecfca80e00998f73","order":13,"project":"57041653ecfca80e00998f70","category":"57a0a705c809e00e00df9cb5","githubsync":"","isReference":true,"link_external":false,"link_url":"","__v":2,"parentDoc":null,"slug":"add-note","title":"Add Note","user":"57041635473f900e004d5a35","api":{"examples":{"codes":[]},"method":"post","params":[{"_id":"57a234b75220910e002a17a4","ref":"","in":"body","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a234b75220910e002a17a3","ref":"","in":"body","required":true,"desc":"The note content.","default":"","type":"string","name":"content"},{"_id":"57a234b75220910e002a17a2","ref":"","in":"body","required":false,"desc":"The note content.","default":"","type":"boolean","name":"is_private"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/add_note","auth":"required"},"body":"","excerpt":"Add a note to an assignment.","type":"post","next":{"description":"","pages":[]},"childrenPages":[]}

postAdd Note

Add a note to an assignment.

Body Params

id:
required
long
The assignment identifier number.
content:
required
string
The note content.
is_private:
boolean
The note content.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a229e7f724ae1900df4949","parentDoc":null,"project":"57041653ecfca80e00998f70","type":"post","updates":[],"user":"57041635473f900e004d5a35","excerpt":"Update all custom fields on the assignment. Unlike the assignments/{id}/edit endpoint, this allows updates regardless of assignment status.","link_url":"","slug":"update","title":"Update Custom Fields","api":{"auth":"required","examples":{"codes":[{"code":"curl -X POST -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'custom_field_groups[0][fields][0][value]=Blah&custom_field_groups[0][id]=1006&custom_field_groups[0][fields][0][id]=4381' \"https://www.workmarket.com/api/v1/assignments/ASSIGNMENT_ID/custom_fields\"","language":"curl"},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/x-www-form-urlencoded\");\nRequestBody body = RequestBody.create(mediaType, \"custom_field_groups%5B0%5D%5Bfields%5D%5B0%5D%5Bvalue%5D=Blah&custom_field_groups%5B0%5D%5Bid%5D=1006&custom_field_groups%5B0%5D%5Bfields%5D%5B0%5D%5Bid%5D=4381\");\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/ASSIGNMENT_ID/custom_fields\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer YOUR_ACCESS_TOKEN_HERE\")\n  .addHeader(\"content-type\", \"application/x-www-form-urlencoded\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"post","params":[{"in":"path","required":false,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a229e7f724ae1900df494a","ref":""},{"required":false,"desc":"ID of the custom field group to position at index [0] on the assignment.","default":"","type":"int","name":"custom_field_groups[0][id]","_id":"57a22b7bafc3050e000cf403","ref":"","in":"body"},{"ref":"","in":"body","required":false,"desc":"ID of the custom field at index [0] within the custom field group at index [0] on the assignment.","default":"","type":"int","name":"custom_field_groups[0][fields][0][id]","_id":"57a22b7bafc3050e000cf402"},{"in":"body","required":false,"desc":"Value to set for the custom field at index [0] within the custom field group at index [0] on the assignment.","default":"","type":"string","name":"custom_field_groups[0][fields][0][value]","_id":"57a22b7bafc3050e000cf401","ref":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/:id/custom_fields"},"createdAt":"2016-08-03T17:29:11.070Z","order":14,"link_external":false,"category":"57a0a705c809e00e00df9cb5","githubsync":"","hidden":false,"isReference":true,"sync_unique":"","version":"57041653ecfca80e00998f73","__v":1,"body":"","childrenPages":[]}

postUpdate Custom Fields

Update all custom fields on the assignment. Unlike the assignments/{id}/edit endpoint, this allows updates regardless of assignment status.

Path Params

id:
long
The assignment identifier number.

Body Params

custom_field_groups[0][id]:
integer
ID of the custom field group to position at index [0] on the assignment.
custom_field_groups[0][fields][0][id]:
integer
ID of the custom field at index [0] within the custom field group at index [0] on the assignment.
custom_field_groups[0][fields][0][value]:
string
Value to set for the custom field at index [0] within the custom field group at index [0] on the assignment.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"57a22e89cd51b22d00f62437","user":"57041635473f900e004d5a35","parentDoc":null,"slug":"complete","type":"post","title":"Complete Assignment (on behalf of worker)","category":"57a0a705c809e00e00df9cb5","createdAt":"2016-08-03T17:48:57.495Z","isReference":true,"hidden":false,"link_url":"","order":15,"sync_unique":"","updates":[],"api":{"method":"post","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id"},{"_id":"57a22e89cd51b22d00f6243e","ref":"","in":"body","required":true,"desc":"A comment on the resolution of the assignment.","default":"","type":"string","name":"resolution"},{"_id":"57a22e89cd51b22d00f6243d","ref":"","in":"body","required":false,"desc":"(Hourly assignments only) The number of hours worked. This provides the basis for the cost of hourly assignments.","default":"","type":"float","name":"hours_worked"},{"_id":"57a22e89cd51b22d00f6243c","ref":"","in":"body","required":false,"desc":"(Per Unit assignments only) The number of units processed. This provides the basis for the cost of \"per unit\" assignments.","default":"","type":"int","name":"units"},{"_id":"57a22e89cd51b22d00f6243b","ref":"","in":"body","required":false,"desc":"Use to override the current amount of approved expenses. Note: can only provide a value that is lower than the current amount of approved expenses.","default":"","type":"float","name":"override_additional_expenses"},{"_id":"57a22e89cd51b22d00f6243a","ref":"","in":"body","required":false,"desc":"Use to override the base price (i.e. excluding expenses and bonuses). Note: can only provide a value that is lower than the current base price.","default":"","type":"float","name":"override_price"},{"_id":"57a22e89cd51b22d00f62439","ref":"","in":"body","required":false,"desc":"The tax rate for this particular worker for this assignment, i.e. \"30\" for 30 percent. Note: the worker is responsible for tax obligations for services and materials. No taxes will be deducted from worker earnings. At any time, workers can run an earnings report that includes tax obligation data.","default":"","type":"int","name":"tax_rate"},{"_id":"57a22e89cd51b22d00f62438","ref":"","in":"body","required":false,"desc":"If true, the assignment will be immediately approved for payment.","default":"","type":"boolean","name":"approve_payment"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/:id/complete","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"Authorization: Bearer  YOUR_ACCESS_TOKEN_HERE\" -H \"Cache-Control: no-cache\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'resolution=Work completed!&approve_payment=1&hours_worked=32&=' \"https://www.workmarket.com/api/v1/assignments/ASSIGNMENT_ID/complete\""},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse(\"application/x-www-form-urlencoded\");\nRequestBody body = RequestBody.create(mediaType, \"resolution=Work%20completed!&approve_payment=1&hours_worked=32&=\");\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/ASSIGNMENT_ID/complete\")\n  .post(body)\n  .addHeader(\"authorization\", \"Bearer  YOUR_ACCESS_TOKEN_HERE\")\n  .addHeader(\"content-type\", \"application/x-www-form-urlencoded\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]}},"excerpt":"Complete the assignment on behalf of the worker. Optionally approve for payment as well.","link_external":false,"project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","__v":1,"body":"","githubsync":"","next":{"description":"","pages":[]},"childrenPages":[]}

postComplete Assignment (on behalf of worker)

Complete the assignment on behalf of the worker. Optionally approve for payment as well.

Path Params

id:
required
long
The assignment identifier number.

Body Params

resolution:
required
string
A comment on the resolution of the assignment.
hours_worked:
float
(Hourly assignments only) The number of hours worked. This provides the basis for the cost of hourly assignments.
units:
integer
(Per Unit assignments only) The number of units processed. This provides the basis for the cost of "per unit" assignments.
override_additional_expenses:
float
Use to override the current amount of approved expenses. Note: can only provide a value that is lower than the current amount of approved expenses.
override_price:
float
Use to override the base price (i.e. excluding expenses and bonuses). Note: can only provide a value that is lower than the current base price.
tax_rate:
integer
The tax rate for this particular worker for this assignment, i.e. "30" for 30 percent. Note: the worker is responsible for tax obligations for services and materials. No taxes will be deducted from worker earnings. At any time, workers can run an earnings report that includes tax obligation data.
approve_payment:
boolean
If true, the assignment will be immediately approved for payment.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"57a22eb6d778850e0047e3a2","api":{"method":"post","params":[{"required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a22eb6d778850e0047e3a3","ref":"","in":"body"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/approve_payment","auth":"required","examples":{"codes":[]}},"body":"","updates":[],"__v":0,"createdAt":"2016-08-03T17:49:42.390Z","link_url":"","order":16,"project":"57041653ecfca80e00998f70","category":"57a0a705c809e00e00df9cb5","excerpt":"Transitions the assignment from \"Pending Approval\" status to either \"Paid\" or \"Invoices\", conditional on the payment terms of the assignment.","githubsync":"","hidden":false,"parentDoc":null,"slug":"approve-for-payment","sync_unique":"","type":"post","version":"57041653ecfca80e00998f73","isReference":true,"link_external":false,"title":"Approve for Payment","user":"57041635473f900e004d5a35","childrenPages":[]}

postApprove for Payment

Transitions the assignment from "Pending Approval" status to either "Paid" or "Invoices", conditional on the payment terms of the assignment.

Body Params

id:
required
long
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22ec2f724ae1900df4950","__v":1,"project":"57041653ecfca80e00998f70","type":"post","link_url":"","title":"Reject for Payment","api":{"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/reject_payment","auth":"required","examples":{"codes":[]},"method":"post","params":[{"default":"","type":"long","name":"id","_id":"57a22eb6d778850e0047e3a3","ref":"","in":"body","required":true,"desc":"The assignment identifier number."},{"default":"","type":"string","name":"note","_id":"57a22ed6cd51b22d00f62440","ref":"","in":"body","required":false,"desc":"Note documenting for the worker why the assignment was not approved for payment."}]},"createdAt":"2016-08-03T17:49:54.210Z","excerpt":"Transitions the assignment from \"Pending Approval\" status back to \"In Progress\".","isReference":true,"link_external":false,"body":"","sync_unique":"","updates":[],"user":"57041635473f900e004d5a35","slug":"reject-for-payment","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","githubsync":"","hidden":false,"order":17,"parentDoc":null,"childrenPages":[]}

postReject for Payment

Transitions the assignment from "Pending Approval" status back to "In Progress".

Body Params

id:
required
long
The assignment identifier number.
note:
string
Note documenting for the worker why the assignment was not approved for payment.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5a7cac11b20b2c00120707cd","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a0a705c809e00e00df9cb5","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-08T19:59:13.882Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://www.workmarket.com/api/v1/assignments/rate_assignment \\\n  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'Postman-Token: c03d2748-8f74-ee42-1f90-1794e19df435' \\\n  -d 'id=99999999&quality=3&professionalism=3&communication=2&review=Worker%20did%20a%20pretty%20good%20job%2C%20but%20could%20have%20been%20a%20little%20better%20at%20communicating.&value=3'"}]},"settings":"","examples":{"codes":[]},"auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243e","ref":"","in":"body","required":true,"desc":"The assignment identifier number.","default":"","type":"string","name":"id"},{"_id":"5a7b4923724509001c038285","ref":"","in":"body","required":true,"desc":"Valid values are 3 (which corresponds to \"EXCELLENT\"), 2 (which corresponds to \"SATISFIED\"), and 1 (which corresponds to \"UNSATISFIED\")","default":"","type":"int","name":"quality"},{"_id":"5a7b4923724509001c038284","ref":"","in":"body","required":true,"desc":"Valid values are 3 (which corresponds to \"EXCELLENT\"), 2 (which corresponds to \"SATISFIED\"), and 1 (which corresponds to \"UNSATISFIED\")","default":"","type":"int","name":"professionalism"},{"_id":"5a7cac11b20b2c00120707d0","ref":"","in":"body","required":true,"desc":"Valid values are 3 (which corresponds to \"EXCELLENT\"), 2 (which corresponds to \"SATISFIED\"), and 1 (which corresponds to \"UNSATISFIED\")","default":"","type":"int","name":"communication"},{"_id":"5a7cac11b20b2c00120707cf","ref":"","in":"body","required":true,"desc":"Valid values are 3 (which corresponds to \"EXCELLENT\"), 2 (which corresponds to \"SATISFIED\"), and 1 (which corresponds to \"UNSATISFIED\")","default":"","type":"int","name":"value"},{"_id":"5a7cac11b20b2c00120707ce","ref":"","in":"body","required":false,"desc":"A review of the worker's performance","default":"","type":"string","name":"review"}],"url":"/assignments/rate_assignment"},"isReference":true,"order":18,"body":"","excerpt":"Rate a worker's performance on an assignment. \n\nA worker must be associated with the assignment in order to rate. If a rating already exists, the endpoint will update/override that rating.\n\nIf the assignment's status is \"paid\", an initial rating can be added if one is not already there, but updating/overriding an existing rating is forbidden.","slug":"rate-assignment","type":"post","title":"Rate Assignment","__v":1,"parentDoc":null,"childrenPages":[]}

postRate Assignment

Rate a worker's performance on an assignment. A worker must be associated with the assignment in order to rate. If a rating already exists, the endpoint will update/override that rating. If the assignment's status is "paid", an initial rating can be added if one is not already there, but updating/overriding an existing rating is forbidden.

Body Params

id:
required
string
The assignment identifier number.
quality:
required
integer
Valid values are 3 (which corresponds to "EXCELLENT"), 2 (which corresponds to "SATISFIED"), and 1 (which corresponds to "UNSATISFIED")
professionalism:
required
integer
Valid values are 3 (which corresponds to "EXCELLENT"), 2 (which corresponds to "SATISFIED"), and 1 (which corresponds to "UNSATISFIED")
communication:
required
integer
Valid values are 3 (which corresponds to "EXCELLENT"), 2 (which corresponds to "SATISFIED"), and 1 (which corresponds to "UNSATISFIED")
value:
required
integer
Valid values are 3 (which corresponds to "EXCELLENT"), 2 (which corresponds to "SATISFIED"), and 1 (which corresponds to "UNSATISFIED")
review:
string
A review of the worker's performance

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"57a22f0ef724ae1900df4952","link_external":false,"body":"","githubsync":"","isReference":true,"order":0,"type":"post","version":"57041653ecfca80e00998f73","category":"57a23250d778850e0047e3b0","link_url":"","project":"57041653ecfca80e00998f70","slug":"accept-offer","sync_unique":"","title":"Accept Offer","updates":[],"__v":0,"createdAt":"2016-08-03T17:51:10.327Z","parentDoc":null,"user":"57041635473f900e004d5a35","api":{"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/offers/accept","auth":"required","examples":{"codes":[]},"method":"post","params":[{"in":"body","required":true,"desc":"The ID of the offer to accept.","default":"","type":"long","name":"id","_id":"57a22f0ef724ae1900df4953","ref":""}]},"excerpt":"Accept an offer for an assignment.","hidden":false,"childrenPages":[]}

postAccept Offer

Accept an offer for an assignment.

Body Params

id:
required
long
The ID of the offer to accept.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22f28afc3050e000cf407","category":"57a23250d778850e0047e3b0","hidden":false,"sync_unique":"","updates":[],"__v":1,"order":1,"parentDoc":null,"title":"Decline Offer","body":"","link_url":"","project":"57041653ecfca80e00998f70","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"57a22f41d778850e0047e3a6","ref":"","in":"body","required":true,"desc":"The ID of the offer to decline.","default":"","type":"long","name":"id"},{"name":"note","_id":"57a22f41d778850e0047e3a5","ref":"","in":"body","required":false,"desc":"A note explaining why the offer was declined.","default":"","type":"string"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/offers/decline"},"createdAt":"2016-08-03T17:51:36.819Z","excerpt":"Decline an offer for an assignment.","githubsync":"","isReference":true,"link_external":false,"slug":"decline-offer","type":"post","version":"57041653ecfca80e00998f73","user":"57041635473f900e004d5a35","childrenPages":[]}

postDecline Offer

Decline an offer for an assignment.

Body Params

id:
required
long
The ID of the offer to decline.
note:
string
A note explaining why the offer was declined.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22f89851a9a0e008cbdc8","body":"","createdAt":"2016-08-03T17:53:13.635Z","excerpt":"Request to reschedule an assignment.","link_url":"","next":{"description":"","pages":[]},"order":2,"project":"57041653ecfca80e00998f70","__v":1,"version":"57041653ecfca80e00998f73","sync_unique":"","category":"57a23250d778850e0047e3b0","parentDoc":null,"user":"57041635473f900e004d5a35","api":{"examples":{"codes":[]},"method":"post","params":[{"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a22f89851a9a0e008cbdcb","ref":"","in":"body","required":true},{"_id":"57a22f89851a9a0e008cbdca","ref":"","in":"body","required":true,"desc":"Start time of an assignment in Unix time, yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z formats. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.","default":"","type":"string","name":"scheduled_start"},{"_id":"57a22f89851a9a0e008cbdc9","ref":"","in":"body","required":false,"desc":"If the schedule is a range, end time of an assignment in Unix time, yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.","default":"","type":"string","name":"scheduled_end"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/reschedule","auth":"required"},"type":"post","updates":[],"link_external":false,"githubsync":"","hidden":false,"isReference":true,"slug":"reschedule","title":"Reschedule","childrenPages":[]}

postReschedule

Request to reschedule an assignment.

Body Params

id:
required
long
The assignment identifier number.
scheduled_start:
required
string
Start time of an assignment in Unix time, yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z formats. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.
scheduled_end:
string
If the schedule is a range, end time of an assignment in Unix time, yyyy/MM/dd hh:mm a z or MM/dd/yyyy hh:mm a z format. Note: if you do not provide an explicit time zone, assignment local time will be assumed. If assignment is virtual, your company local time zone will be used.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22fb55220910e002a178f","slug":"accept-reschedule","sync_unique":"","createdAt":"2016-08-03T17:53:57.473Z","hidden":false,"link_external":false,"order":3,"type":"post","body":"","category":"57a23250d778850e0047e3b0","excerpt":"Accept an assignment reschedule request.","project":"57041653ecfca80e00998f70","api":{"url":"/assignments/accept_reschedule","auth":"required","examples":{"codes":[]},"method":"post","params":[{"ref":"","in":"body","required":true,"desc":"The assignment identifier number.","default":"","type":"string","name":"id","_id":"57a22fb55220910e002a1790"}],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"isReference":true,"parentDoc":null,"title":"Accept Reschedule","updates":[],"user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","__v":0,"githubsync":"","link_url":"","childrenPages":[]}

postAccept Reschedule

Accept an assignment reschedule request.

Body Params

id:
required
string
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22fe8f724ae1900df4954","slug":"decline-reschedule","type":"post","api":{"examples":{"codes":[]},"method":"post","params":[{"default":"","type":"string","name":"id","_id":"57a22fb55220910e002a1790","ref":"","in":"body","required":true,"desc":"The assignment identifier number."},{"default":"","type":"string","name":"note","_id":"57a22fe8f724ae1900df4955","ref":"","in":"body","required":false,"desc":"A note explaining why the reschedule was declined."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/decline_reschedule","auth":"required"},"body":"","category":"57a23250d778850e0047e3b0","createdAt":"2016-08-03T17:54:48.574Z","link_url":"","project":"57041653ecfca80e00998f70","__v":0,"isReference":true,"parentDoc":null,"sync_unique":"","updates":[],"version":"57041653ecfca80e00998f73","user":"57041635473f900e004d5a35","excerpt":"Decline an assignment reschedule request.","githubsync":"","hidden":false,"link_external":false,"order":4,"title":"Decline Reschedule","childrenPages":[]}

postDecline Reschedule

Decline an assignment reschedule request.

Body Params

id:
required
string
The assignment identifier number.
note:
string
A note explaining why the reschedule was declined.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23000afc3050e000cf408","body":"","category":"57a23250d778850e0047e3b0","githubsync":"","hidden":false,"link_external":false,"type":"post","user":"57041635473f900e004d5a35","api":{"examples":{"codes":[]},"method":"post","params":[{"in":"path","name":"id","ref":"","required":true,"type":"long","_id":"57a230625220910e002a1795","default":"","desc":"The assignment identifier number."},{"type":"float","name":"flat_price","_id":"57a230625220910e002a1794","ref":"","in":"body","required":false,"desc":"The new flat price, for flat price assignments","default":""},{"desc":"The new maximum number of billable hours for hourly price assignments.","default":"","type":"int","name":"max_number_of_hours","_id":"57a230625220910e002a1793","ref":"","in":"body","required":false},{"_id":"57a230625220910e002a1792","ref":"","in":"body","required":false,"desc":"The new maximum number of additional hours (at the secondary rate) for blended per hour assignments.","default":"","type":"int","name":"max_blended_number_of_hours"},{"_id":"57a230625220910e002a1791","ref":"","in":"body","required":false,"desc":"The new maximum number of units for price per unit assignments.","default":"","type":"int","name":"max_number_of_units"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/:id/pricing/budget_increase","auth":"required"},"createdAt":"2016-08-03T17:55:12.938Z","isReference":true,"slug":"budget-increase","updates":[],"excerpt":"Increase the budget for an assignment. Use this endpoint to increase the budget for an assignment. Note that the total assignment budget can only be modified upwards, not downwards, using this endpoint.","order":5,"parentDoc":null,"title":"Add Budget Increase","version":"57041653ecfca80e00998f73","__v":1,"link_url":"","project":"57041653ecfca80e00998f70","sync_unique":"","childrenPages":[]}

postAdd Budget Increase

Increase the budget for an assignment. Use this endpoint to increase the budget for an assignment. Note that the total assignment budget can only be modified upwards, not downwards, using this endpoint.

Path Params

id:
required
long
The assignment identifier number.

Body Params

flat_price:
float
The new flat price, for flat price assignments
max_number_of_hours:
integer
The new maximum number of billable hours for hourly price assignments.
max_blended_number_of_hours:
integer
The new maximum number of additional hours (at the secondary rate) for blended per hour assignments.
max_number_of_units:
integer
The new maximum number of units for price per unit assignments.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23097f724ae1900df4956","slug":"accept-budget-increase","type":"post","api":{"method":"post","params":[{"name":"id","ref":"","required":true,"type":"long","_id":"57a23097f724ae1900df4957","default":"","desc":"The assignment identifier number.","in":"body"}],"results":{"codes":[{"code":"","language":"text"}]},"settings":"","url":"/assignments/accept_budget_increase","auth":"required","examples":{"codes":[]}},"body":"","excerpt":"Accept a budget increase request.","isReference":true,"project":"57041653ecfca80e00998f70","sync_unique":"","title":"Accept Budget Increase","updates":[],"__v":0,"category":"57a23250d778850e0047e3b0","githubsync":"","parentDoc":null,"user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","link_external":false,"link_url":"","createdAt":"2016-08-03T17:57:43.712Z","hidden":false,"order":6,"childrenPages":[]}

postAccept Budget Increase

Accept a budget increase request.

Body Params

id:
required
long
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a230b6afc3050e000cf409","createdAt":"2016-08-03T17:58:14.465Z","parentDoc":null,"title":"Decline Budget Increase","updates":[],"version":"57041653ecfca80e00998f73","githubsync":"","isReference":true,"link_url":"","slug":"decline-budget-increase","type":"post","user":"57041635473f900e004d5a35","__v":0,"category":"57a23250d778850e0047e3b0","link_external":false,"order":7,"project":"57041653ecfca80e00998f70","sync_unique":"","api":{"settings":"","url":"/assignments/decline_budget_increase","auth":"required","examples":{"codes":[]},"method":"post","params":[{"ref":"","required":true,"type":"long","_id":"57a23097f724ae1900df4957","default":"","desc":"The assignment identifier number.","in":"body","name":"id"},{"default":"","type":"string","name":"note","_id":"57a230b6afc3050e000cf40a","ref":"","in":"body","required":false,"desc":"A note explaining why the budget increase was declined."}],"results":{"codes":[{"language":"text","code":""}]}},"body":"","excerpt":"Decline a budget increase request.","hidden":false,"childrenPages":[]}

postDecline Budget Increase

Decline a budget increase request.

Body Params

id:
required
long
The assignment identifier number.
note:
string
A note explaining why the budget increase was declined.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a230db5220910e002a1796","excerpt":"Add a new expense reimbursement to the assignment.","isReference":true,"link_url":"","version":"57041653ecfca80e00998f73","createdAt":"2016-08-03T17:58:51.444Z","api":{"examples":{"codes":[]},"method":"post","params":[{"default":"","type":"long","name":"id","_id":"57a23114851a9a0e008cbdd0","ref":"","in":"path","required":true,"desc":"The assignment identifier number."},{"default":"","type":"float","name":"amount","_id":"57a23114851a9a0e008cbdcf","ref":"","in":"body","required":true,"desc":"The amount of the expense to be reimbursed. It is added to the current expense_reimbursements total, which is available in /assignments/get."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"57a27847dba9ea0e0012c8ef","url":"/assignments/:id/pricing/expense_reimbursement","auth":"required"},"order":8,"sync_unique":"","title":"Add Expense Reimbursement","__v":1,"category":"57a23250d778850e0047e3b0","githubsync":"","hidden":false,"project":"57041653ecfca80e00998f70","slug":"expense-reimbursement","updates":[],"user":"57041635473f900e004d5a35","link_external":false,"parentDoc":null,"type":"post","body":"","childrenPages":[]}

postAdd Expense Reimbursement

Add a new expense reimbursement to the assignment.

Path Params

id:
required
long
The assignment identifier number.

Body Params

amount:
required
float
The amount of the expense to be reimbursed. It is added to the current expense_reimbursements total, which is available in /assignments/get.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23127851a9a0e008cbdd1","isReference":true,"parentDoc":null,"project":"57041653ecfca80e00998f70","sync_unique":"","title":"Accept Expense Reimbursement","user":"57041635473f900e004d5a35","slug":"accept-expense-reimbursement","body":"","createdAt":"2016-08-03T18:00:07.809Z","githubsync":"","hidden":false,"link_url":"","category":"57a23250d778850e0047e3b0","excerpt":"Accept an expense reimbursement request.","link_external":false,"order":9,"updates":[],"__v":1,"api":{"examples":{"codes":[]},"method":"post","params":[{"default":"","type":"long","name":"id","_id":"57a231545220910e002a1799","ref":"","in":"body","required":true,"desc":"The assignment identifier number."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/accept_expense_reimbursement","auth":"required"},"type":"post","version":"57041653ecfca80e00998f73","childrenPages":[]}

postAccept Expense Reimbursement

Accept an expense reimbursement request.

Body Params

id:
required
long
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23165f724ae1900df4958","api":{"settings":"","url":"/assignments/decline_expense_reimbursement","auth":"required","examples":{"codes":[]},"method":"post","params":[{"in":"body","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a23183851a9a0e008cbdd3","ref":""},{"desc":"A note explaining why the expense reimbursement was declined.","default":"","type":"string","name":"note","_id":"57a23183851a9a0e008cbdd2","ref":"","in":"body","required":false}],"results":{"codes":[{"language":"text","code":""}]}},"hidden":false,"isReference":true,"project":"57041653ecfca80e00998f70","user":"57041635473f900e004d5a35","body":"","category":"57a23250d778850e0047e3b0","order":10,"slug":"decline-expense-reimbursement","title":"Decline Expense Reimbursement","type":"post","link_external":false,"link_url":"","updates":[],"version":"57041653ecfca80e00998f73","sync_unique":"","__v":1,"createdAt":"2016-08-03T18:01:09.694Z","excerpt":"Decline an expense reimbursement request.","githubsync":"","parentDoc":null,"childrenPages":[]}

postDecline Expense Reimbursement

Decline an expense reimbursement request.

Body Params

id:
required
long
The assignment identifier number.
note:
string
A note explaining why the expense reimbursement was declined.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a231aa5220910e002a179b","category":"57a23250d778850e0047e3b0","isReference":true,"updates":[],"excerpt":"Accept a bonus request.","link_external":false,"link_url":"","parentDoc":null,"slug":"accept-bonus","sync_unique":"","body":"","createdAt":"2016-08-03T18:02:18.439Z","githubsync":"","title":"Accept Bonus","user":"57041635473f900e004d5a35","__v":0,"api":{"results":{"codes":[{"code":"","language":"text"}]},"settings":"","url":"/assignments/accept_bonus","auth":"required","examples":{"codes":[]},"method":"post","params":[{"required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a231aa5220910e002a179c","ref":"","in":"body"}]},"hidden":false,"order":11,"project":"57041653ecfca80e00998f70","type":"post","version":"57041653ecfca80e00998f73","childrenPages":[]}

postAccept Bonus

Accept a bonus request.

Body Params

id:
required
long
The assignment identifier number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a231c25220910e002a179d","__v":0,"category":"57a23250d778850e0047e3b0","githubsync":"","project":"57041653ecfca80e00998f70","updates":[],"user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","api":{"method":"post","params":[{"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a231aa5220910e002a179c","ref":"","in":"body","required":true},{"_id":"57a231c25220910e002a179e","ref":"","in":"body","required":false,"desc":"A note explaining why the bonus was declined.","default":"","type":"string","name":"note"}],"results":{"codes":[{"code":"","language":"text"}]},"settings":"","url":"/assignments/decline_bonus","auth":"required","examples":{"codes":[]}},"body":"","isReference":true,"order":12,"parentDoc":null,"excerpt":"Decline a bonus request.","link_url":"","title":"Decline Bonus","type":"post","createdAt":"2016-08-03T18:02:42.661Z","hidden":false,"link_external":false,"slug":"decline-bonus","sync_unique":"","childrenPages":[]}

postDecline Bonus

Decline a bonus request.

Body Params

id:
required
long
The assignment identifier number.
note:
string
A note explaining why the bonus was declined.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23237afc3050e000cf40c","body":"","category":"57a23248851a9a0e008cbdd5","hidden":false,"slug":"list-2","updates":[],"api":{"examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.048,\n    \"timestamp\": 1470324476\n  },\n  \"response\": [\n    {\n      \"id\": 383305,\n      \"name\": \"My Cool Label\"\n    },\n    {\n      \"id\": 379333,\n      \"name\": \"Reviewed\"\n    },\n    {\n      \"id\": 549249,\n      \"name\": \"Needs Review\"\n    }\n  ]\n}","name":""}]},"settings":"","url":"/assignments/labels/list","auth":"required"},"__v":0,"githubsync":"","isReference":true,"order":0,"project":"57041653ecfca80e00998f70","sync_unique":"","type":"get","version":"57041653ecfca80e00998f73","createdAt":"2016-08-03T18:04:39.856Z","excerpt":"Retrieve a list of available labels.  See [here](/page/labels) for more on labels.","link_external":false,"link_url":"","parentDoc":null,"title":"List Labels","user":"57041635473f900e004d5a35","childrenPages":[]}

getList Labels

Retrieve a list of available labels. See [here](/page/labels) for more on labels.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"57a23328f724ae1900df495d","link_external":false,"title":"Add Label","user":"57041635473f900e004d5a35","body":"","category":"57a23248851a9a0e008cbdd5","parentDoc":null,"slug":"add","sync_unique":"","updates":[],"__v":0,"hidden":false,"isReference":true,"link_url":"","order":1,"type":"post","api":{"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/labels/add","auth":"required","examples":{"codes":[]},"method":"post","params":[{"in":"body","required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a23328f724ae1900df4960","ref":""},{"required":true,"desc":"The ID of the label to add.","default":"","type":"int","name":"substatus_id","_id":"57a23328f724ae1900df495f","ref":"","in":"body"},{"type":"string","name":"note","_id":"57a23328f724ae1900df495e","ref":"","in":"body","required":false,"desc":"Include a message. Note: depending on the configuration of the label, note may be required.","default":""}]},"createdAt":"2016-08-03T18:08:40.697Z","excerpt":"Add a custom label to an assignment.  Note that system/built-in labels can only be added by the system.  See [here](/page/labels) for more on labels.","githubsync":"","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","childrenPages":[]}

postAdd Label

Add a custom label to an assignment. Note that system/built-in labels can only be added by the system. See [here](/page/labels) for more on labels.

Body Params

id:
required
long
The assignment identifier number.
substatus_id:
required
integer
The ID of the label to add.
note:
string
Include a message. Note: depending on the configuration of the label, note may be required.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23338f724ae1900df4961","excerpt":"Remove a custom label from an assignment.  See [here](/page/labels) for more on labels.","githubsync":"","slug":"remove","order":2,"sync_unique":"","title":"Remove Label","__v":1,"createdAt":"2016-08-03T18:08:56.250Z","isReference":true,"link_external":false,"link_url":"","project":"57041653ecfca80e00998f70","api":{"examples":{"codes":[]},"method":"post","params":[{"default":"","type":"long","name":"id","_id":"57a23328f724ae1900df4960","ref":"","in":"body","required":true,"desc":"The assignment identifier number."},{"in":"body","required":true,"desc":"The ID of the label to remove.","default":"","type":"int","name":"substatus_id","_id":"57a23328f724ae1900df495f","ref":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/labels/remove","auth":"required"},"body":"","category":"57a23248851a9a0e008cbdd5","hidden":false,"parentDoc":null,"type":"post","updates":[],"user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","childrenPages":[]}

postRemove Label

Remove a custom label from an assignment. See [here](/page/labels) for more on labels.

Body Params

id:
required
long
The assignment identifier number.
substatus_id:
required
integer
The ID of the label to remove.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a233bff724ae1900df4963","excerpt":"List the attachments of an assignment.","parentDoc":null,"sync_unique":"","user":"57041635473f900e004d5a35","api":{"settings":"","url":"/assignments/attachments/list","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" -H \"Cache-Control: no-cache\" \"https://www.workmarket.com/api/v1/assignments/attachments/list?id=ASSIGNMENT_ID&closeout=1\""},{"language":"java","code":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n  .url(\"https://www.workmarket.com/api/v1/assignments/attachments/list?id=ASSIGNMENT_ID&closeout=1\")\n  .get()\n  .addHeader(\"authorization\", \"Bearer YOUR_ACCESS_TOKEN_HERE\")\n  .build();\n\nResponse response = client.newCall(request).execute();"}]},"method":"get","params":[{"default":"","type":"long","name":"id","_id":"57a233bff724ae1900df4965","ref":"","in":"query","required":true,"desc":"The assignment identifier number."},{"desc":"If true, return \"deliverables\" (i.e. attachments added by the worker), otherwise return \"documents\" (employer-added attachments generally for reference materials).","in":"query","name":"closeout","ref":"","required":false,"type":"boolean","_id":"57a233bff724ae1900df4964","default":"0"}],"results":{"codes":[{"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 4.236,\n    \"timestamp\": 1470331544\n  },\n  \"response\": [\n    {\n      \"uuid\": \"e8953d44-ef1a-4ff8-84fb-afa23163531\",\n      \"filename\": \"logo.png\"\n    },\n    {\n      \"uuid\": \"481636d5-2ff4-4508-88fb-3a31c56ed4aa\",\n      \"filename\": \"cat.png\"\n    }\n  ]\n}","status":200}]}},"createdAt":"2016-08-03T18:11:11.467Z","order":0,"project":"57041653ecfca80e00998f70","type":"get","updates":["589a22aae94a202500fa2e82"],"version":"57041653ecfca80e00998f73","__v":1,"body":"","hidden":false,"link_url":"","category":"57a23373afc3050e000cf40d","githubsync":"","isReference":true,"link_external":false,"slug":"list-3","title":"List Attachments","childrenPages":[]}

getList Attachments

List the attachments of an assignment.

Query Params

id:
required
long
The assignment identifier number.
closeout:
boolean0
If true, return "deliverables" (i.e. attachments added by the worker), otherwise return "documents" (employer-added attachments generally for reference materials).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"57a233eecd51b22d00f62448","__v":0,"excerpt":"Get a specific assignment attachment.","order":1,"parentDoc":null,"project":"57041653ecfca80e00998f70","type":"get","api":{"method":"get","params":[{"name":"uuid","ref":"","required":true,"type":"string","_id":"57a233eecd51b22d00f62449","default":"","desc":"Attachment unique identifier.","in":"query"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/attachments/get","auth":"required","examples":{"codes":[]}},"body":"","link_url":"","slug":"get-1","title":"Get Attachment","version":"57041653ecfca80e00998f73","category":"57a23373afc3050e000cf40d","createdAt":"2016-08-03T18:11:58.789Z","sync_unique":"","updates":[],"githubsync":"","hidden":false,"isReference":true,"link_external":false,"user":"57041635473f900e004d5a35","childrenPages":[]}

getGet Attachment

Get a specific assignment attachment.

Query Params

uuid:
required
string
Attachment unique identifier.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23407afc3050e000cf40e","user":"57041635473f900e004d5a35","parentDoc":null,"slug":"add-1","sync_unique":"","__v":2,"link_external":false,"excerpt":"Add an attachment to an assignment.","githubsync":"","hidden":false,"isReference":true,"type":"post","updates":[],"api":{"settings":"","url":"/assignments/attachments/add","auth":"required","examples":{"codes":[]},"method":"post","params":[{"default":"","type":"long","name":"id","_id":"57a23436afc3050e000cf412","ref":"","in":"body","required":true,"desc":"The assignment identifier number."},{"in":"body","required":true,"desc":"This is the Base64 encoded binary attachment data.","default":"","type":"string","name":"attachment","_id":"57a23436afc3050e000cf411","ref":""},{"required":true,"desc":"The filename of the attachment.","default":"","type":"string","name":"filename","_id":"57a23436afc3050e000cf410","ref":"","in":"body"},{"type":"string","name":"description","_id":"57a23436afc3050e000cf40f","ref":"","in":"body","required":false,"desc":"A description of the attachment.","default":""}],"results":{"codes":[{"code":"","language":"text"}]}},"category":"57a23373afc3050e000cf40d","link_url":"","next":{"description":"","pages":[]},"order":2,"project":"57041653ecfca80e00998f70","title":"Add Attachment","version":"57041653ecfca80e00998f73","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Use \\\"multipart/form-data\\\"\",\n  \"body\": \"For this endpoint, use \\\"multipart/form-data\\\" as the content-type.  This will allow for larger files to be transmitted more reliably.  Presently, the limit is 50MB for the *Base64 serialized file data*, which usually translates to about 35MB for the source file.\"\n}\n[/block]","createdAt":"2016-08-03T18:12:23.996Z","childrenPages":[]}

postAdd Attachment

Add an attachment to an assignment.

Body Params

id:
required
long
The assignment identifier number.
attachment:
required
string
This is the Base64 encoded binary attachment data.
filename:
required
string
The filename of the attachment.
description:
string
A description of the attachment.
[block:callout] { "type": "warning", "title": "Use \"multipart/form-data\"", "body": "For this endpoint, use \"multipart/form-data\" as the content-type. This will allow for larger files to be transmitted more reliably. Presently, the limit is 50MB for the *Base64 serialized file data*, which usually translates to about 35MB for the source file." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "warning", "title": "Use \"multipart/form-data\"", "body": "For this endpoint, use \"multipart/form-data\" as the content-type. This will allow for larger files to be transmitted more reliably. Presently, the limit is 50MB for the *Base64 serialized file data*, which usually translates to about 35MB for the source file." } [/block]
{"_id":"57a23467afc3050e000cf413","parentDoc":null,"api":{"method":"post","params":[{"required":true,"desc":"The assignment identifier number.","default":"","type":"long","name":"id","_id":"57a23436afc3050e000cf412","ref":"","in":"body"},{"ref":"","in":"body","required":true,"desc":"The unique identifier of the attachment to remove.","default":"","type":"string","name":"uuid","_id":"57a23467afc3050e000cf414"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/attachments/remove","auth":"required","examples":{"codes":[]}},"category":"57a23373afc3050e000cf40d","isReference":true,"link_external":false,"link_url":"","githubsync":"","sync_unique":"","body":"","hidden":false,"version":"57041653ecfca80e00998f73","slug":"remove-1","title":"Remove Attachment","type":"post","__v":0,"createdAt":"2016-08-03T18:13:59.196Z","excerpt":"Remove an attachment from an assignment.","order":3,"project":"57041653ecfca80e00998f70","updates":[],"user":"57041635473f900e004d5a35","childrenPages":[]}

postRemove Attachment

Remove an attachment from an assignment.

Body Params

id:
required
long
The assignment identifier number.
uuid:
required
string
The unique identifier of the attachment to remove.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a234d35220910e002a17a5","user":"57041635473f900e004d5a35","body":"","excerpt":"Retrieve a list of assignment templates.","link_external":false,"title":"List Templates","type":"get","updates":[],"__v":0,"api":{"url":"/assignments/templates/list","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"isReference":true,"sync_unique":"","githubsync":"","order":0,"parentDoc":null,"project":"57041653ecfca80e00998f70","slug":"list-4","category":"57a234c5cd51b22d00f6244a","createdAt":"2016-08-03T18:15:47.610Z","hidden":false,"link_url":"","version":"57041653ecfca80e00998f73","childrenPages":[]}

getList Templates

Retrieve a list of assignment templates.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a2351bd778850e0047e3b5","category":"57a234c5cd51b22d00f6244a","excerpt":"Get details of an assignment template.","link_url":"","parentDoc":null,"__v":0,"api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"default":"","type":"long","name":"id","_id":"57a2351bd778850e0047e3b6","ref":"","in":"query","required":true,"desc":"The ID of the template to fetch."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/assignments/templates/get"},"isReference":true,"order":1,"project":"57041653ecfca80e00998f70","slug":"get-2","body":"","hidden":false,"link_external":false,"sync_unique":"","title":"Get Template","type":"get","updates":[],"createdAt":"2016-08-03T18:16:59.994Z","githubsync":"","user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","childrenPages":[]}

getGet Template

Get details of an assignment template.

Query Params

id:
required
long
The ID of the template to fetch.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a22919851a9a0e008cbdc0","githubsync":"","link_external":false,"parentDoc":null,"project":"57041653ecfca80e00998f70","user":"57041635473f900e004d5a35","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.34,\n    \"timestamp\": 1470265907\n  },\n  \"response\": [\n    {\n      \"id\": 155,\n      \"name\": \"Standard Custom Fields\",\n      \"required\": false,\n      \"fields\": [\n        {\n          \"id\": 864,\n          \"name\": \"Salesforce ID\",\n          \"default\": \"\",\n          \"required\": true\n        },\n        {\n          \"id\": 865,\n          \"name\": \"Labor Type\",\n          \"default\": \"Do Not Invoice,1-Flat,2-Hourly,Cancellation Fee\",\n          \"required\": true\n        },\n        {\n          \"id\": 868,\n          \"name\": \"Trip Charge\",\n          \"default\": \"\",\n          \"required\": false\n        }\n      ]\n    }\n  ]\n}\n      ","name":""}]},"settings":"","url":"/assignments/customfields/list"},"body":"","excerpt":"","link_url":"","next":{"description":"","pages":[]},"type":"get","updates":[],"slug":"list-1","__v":1,"category":"57a22907cd51b22d00f62394","createdAt":"2016-08-03T17:25:45.538Z","hidden":false,"isReference":true,"order":0,"sync_unique":"","title":"List Custom Fields","version":"57041653ecfca80e00998f73","childrenPages":[]}

getList Custom Fields



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"57a23542f724ae1900df4966","__v":1,"body":"","category":"57a23528cd51b22d00f6244b","excerpt":"Retrieve a list of talent pools.","githubsync":"","hidden":false,"isReference":true,"title":"List Talent Pools","user":"57041635473f900e004d5a35","api":{"method":"get","params":[{"_id":"59c3c55d31215300108e8c7b","ref":"","in":"query","required":false,"desc":"Where in the list of talent pools to start listing","default":"0","type":"int","name":"iDisplayStart"},{"_id":"59c3c55d31215300108e8c7a","ref":"","in":"query","required":false,"desc":"How many records to show","default":"25","type":"int","name":"iDisplayLength"}],"results":{"codes":[{"code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.08,\n    \"timestamp\": 1470333408\n  },\n  \"response\": [\n    {\n      \"id\": 27861,\n      \"name\": \"My Paid Workers\",\n      \"description\": \"Auto generated group My Paid Workers\",\n      \"members\": 4,\n      \"active\": true,\n      \"deleted\": false\n    },\n    {\n      \"id\": 29669,\n      \"name\": \"World's Greatest Java Developers\",\n      \"description\": \"Take the test and be part of the best.\",\n      \"members\": 0,\n      \"active\": false,\n      \"deleted\": false\n    }\n  ]\n}","language":"json","status":200}]},"settings":"","url":"/groups/list","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN_HERE\" -H \"Cache-Control: no-cache\" \"https://www.workmarket.com/api/v1/groups/list\""}]}},"parentDoc":null,"sync_unique":"","link_url":"","order":0,"project":"57041653ecfca80e00998f70","slug":"list-5","version":"57041653ecfca80e00998f73","createdAt":"2016-08-03T18:17:38.915Z","link_external":false,"type":"get","updates":[],"next":{"description":"","pages":[]},"childrenPages":[]}

getList Talent Pools

Retrieve a list of talent pools.

Query Params

iDisplayStart:
integer0
Where in the list of talent pools to start listing
iDisplayLength:
integer25
How many records to show

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5a7ca4f3324bc1001f64b022","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a23528cd51b22d00f6244b","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-08T19:28:51.428Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://www.workmarket.com/api/v1/groups/1234/add_workers \\\n  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -d '[\"99999999\", \"99999988\"]'"}]},"auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The talent pool identifier number.","default":"","type":"long","name":"id"},{"_id":"5a7ca4f3324bc1001f64b023","ref":"","in":"body","required":false,"desc":"No key! Input is an array of worker_id's you want to add to the talent pool","default":"","type":"array_string","name":"-"}],"url":"/groups/:id/add_workers"},"isReference":true,"order":1,"body":"","excerpt":"If the talent pool is public, you will be inviting the worker to the talent pool. If the talent pool is private, the worker will be added automatically.\n\nNOTE: This endpoint accepts JSON rather than form-urlencoded.","slug":"add-worker-to-talent-pool","type":"post","title":"Add Workers to Talent Pool","__v":3,"parentDoc":null,"childrenPages":[]}

postAdd Workers to Talent Pool

If the talent pool is public, you will be inviting the worker to the talent pool. If the talent pool is private, the worker will be added automatically. NOTE: This endpoint accepts JSON rather than form-urlencoded.

Path Params

id:
required
long
The talent pool identifier number.

Body Params

-:
array of strings
No key! Input is an array of worker_id's you want to add to the talent pool

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"5a7ca54ec79e5f001203622d","project":"57041653ecfca80e00998f70","version":"57041653ecfca80e00998f73","category":"57a23528cd51b22d00f6244b","user":"5a7b14bd5a70ed005812fc68","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-08T19:30:22.025Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://www.workmarket.com/api/v1/groups/1234/remove_workers \\\n  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -d '[\"99999999\", \"99999988\"]'"}]},"settings":"","results":{"codes":[{"language":"text","code":""}]},"method":"post","auth":"required","params":[{"_id":"57a22e89cd51b22d00f6243f","ref":"","in":"path","required":true,"desc":"The talent pool identifier number.","default":"","type":"long","name":"id"},{"_id":"5a7ca4f3324bc1001f64b023","ref":"","in":"body","required":false,"desc":"No key! Input is an array of worker_id's you want to remove from the talent pool.","default":"","type":"array_string","name":"-"}],"url":"/groups/:id/remove_workers"},"isReference":true,"order":2,"body":"","excerpt":"Removes worker from a talent pool - public or private.\n\nNOTE: This endpoint accepts JSON rather than form-urlencoded.","slug":"remove-workers-from-talent-pool","type":"post","title":"Remove Workers from Talent Pool","__v":2,"parentDoc":null,"childrenPages":[]}

postRemove Workers from Talent Pool

Removes worker from a talent pool - public or private. NOTE: This endpoint accepts JSON rather than form-urlencoded.

Path Params

id:
required
long
The talent pool identifier number.

Body Params

-:
array of strings
No key! Input is an array of worker_id's you want to remove from the talent pool.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"_id":"57a23556cd51b22d00f6244d","__v":1,"githubsync":"","parentDoc":null,"project":"57041653ecfca80e00998f70","isReference":true,"link_external":false,"order":0,"excerpt":"Retrieve a list of projects by client_id.","sync_unique":"","title":"List Projects","type":"get","api":{"settings":"","url":"/projects/list","auth":"required","examples":{"codes":[]},"method":"get","params":[{"default":"","type":"long","name":"client_id","_id":"57a235ba5220910e002a17a8","ref":"","in":"query","required":true,"desc":"ID of the end-client to list projects for."}],"results":{"codes":[{"language":"text","code":""}]}},"body":"","category":"57a2355ff724ae1900df496e","version":"57041653ecfca80e00998f73","updates":[],"user":"57041635473f900e004d5a35","createdAt":"2016-08-03T18:17:58.399Z","hidden":false,"link_url":"","slug":"list-6","childrenPages":[]}

getList Projects

Retrieve a list of projects by client_id.

Query Params

client_id:
required
long
ID of the end-client to list projects for.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a235f1f724ae1900df4970","link_external":false,"order":1,"type":"post","version":"57041653ecfca80e00998f73","createdAt":"2016-08-03T18:20:33.846Z","project":"57041653ecfca80e00998f70","slug":"add-2","title":"Add Project","parentDoc":null,"user":"57041635473f900e004d5a35","__v":0,"category":"57a2355ff724ae1900df496e","isReference":true,"link_url":"","sync_unique":"","updates":[],"api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"ref":"","in":"body","required":true,"desc":"ID of the end-client this project is associated with.","default":"","type":"long","name":"client_id","_id":"57a235f1f724ae1900df4973"},{"default":"","type":"string","name":"name","_id":"57a235f1f724ae1900df4972","ref":"","in":"body","required":true,"desc":"The name of the new project."},{"in":"body","required":false,"desc":"A description of the new project.","default":"","type":"string","name":"description","_id":"57a235f1f724ae1900df4971","ref":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/projects/add"},"body":"","excerpt":"Add a new project associated with a client.","githubsync":"","hidden":false,"childrenPages":[]}

postAdd Project

Add a new project associated with a client.

Body Params

client_id:
required
long
ID of the end-client this project is associated with.
name:
required
string
The name of the new project.
description:
string
A description of the new project.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a2368ccd51b22d00f6244f","parentDoc":null,"title":"List Clients","user":"57041635473f900e004d5a35","category":"57a23671afc3050e000cf417","body":"","hidden":false,"isReference":true,"link_url":"","project":"57041653ecfca80e00998f70","slug":"list-7","type":"get","__v":0,"link_external":false,"order":0,"sync_unique":"","updates":[],"createdAt":"2016-08-03T18:23:08.652Z","excerpt":"Retrieve a list of end-clients.","githubsync":"","version":"57041653ecfca80e00998f73","api":{"url":"/crm/clients/list","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"childrenPages":[]}

getList Clients

Retrieve a list of end-clients.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a236b45220910e002a17a9","sync_unique":"","excerpt":"Create a new end-client.","project":"57041653ecfca80e00998f70","order":1,"title":"Add Client","githubsync":"","isReference":true,"body":"","createdAt":"2016-08-03T18:23:48.119Z","hidden":false,"parentDoc":null,"type":"post","user":"57041635473f900e004d5a35","__v":1,"api":{"examples":{"codes":[]},"method":"post","params":[{"in":"body","required":true,"desc":"The end-client's name.","default":"","type":"string","name":"company_name","_id":"57a2371dd778850e0047e3c0","ref":""},{"required":false,"desc":"The name of the industry for this end-client. See constants/industries","default":"","type":"string","name":"industry_name","_id":"57a2371dd778850e0047e3bf","ref":"","in":"body"},{"ref":"","in":"body","required":false,"desc":"The client identifier for integration with external systems.","default":"","type":"string","name":"customer_id","_id":"57a2371dd778850e0047e3be"},{"in":"body","required":false,"desc":"The region this end-client is a part of.","default":"","type":"string","name":"region","_id":"57a2371dd778850e0047e3bd","ref":""},{"required":false,"desc":"The division the end-client is a part of.","default":"","type":"string","name":"division","_id":"57a2371dd778850e0047e3bc","ref":"","in":"body"},{"ref":"","in":"body","required":false,"desc":"Phone number for the end-client.","default":"","type":"string","name":"phone_numbers[0]","_id":"57a2371dd778850e0047e3bb"},{"default":"","type":"string","name":"phone_numbers[0][ext]","_id":"57a2371dd778850e0047e3ba","ref":"","in":"body","required":false,"desc":"Phone number extension, if any."},{"default":"","type":"string","name":"phone_numbers[0][types]","_id":"57a2371dd778850e0047e3b9","ref":"","in":"body","required":false,"desc":"The type of phone number."},{"default":"","type":"string","name":"websites[0]","_id":"57a2371dd778850e0047e3b8","ref":"","in":"body","required":false,"desc":"Web site address for this end-client."}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/addressbook/clients/add","auth":"required"},"link_external":false,"link_url":"","slug":"add-3","updates":[],"version":"57041653ecfca80e00998f73","category":"57a23671afc3050e000cf417","childrenPages":[]}

postAdd Client

Create a new end-client.

Body Params

company_name:
required
string
The end-client's name.
industry_name:
string
The name of the industry for this end-client. See constants/industries
customer_id:
string
The client identifier for integration with external systems.
region:
string
The region this end-client is a part of.
division:
string
The division the end-client is a part of.
phone_numbers[0]:
string
Phone number for the end-client.
phone_numbers[0][ext]:
string
Phone number extension, if any.
phone_numbers[0][types]:
string
The type of phone number.
websites[0]:
string
Web site address for this end-client.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23750d778850e0047e3c3","version":"57041653ecfca80e00998f73","body":"","isReference":true,"link_external":false,"parentDoc":null,"title":"List Locations","createdAt":"2016-08-03T18:26:24.874Z","excerpt":"Retrieve a list of locations by client_id.","hidden":false,"project":"57041653ecfca80e00998f70","type":"get","api":{"url":"/crm/locations/list","auth":"required","examples":{"codes":[]},"method":"get","params":[{"type":"long","name":"client_id","_id":"57a237785220910e002a17aa","ref":"","in":"query","required":false,"desc":"The ID of the end-client whose locations you'd like to fetch.","default":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"githubsync":"","link_url":"","order":0,"sync_unique":"","user":"57041635473f900e004d5a35","__v":1,"category":"57a23741f724ae1900df4975","slug":"list-8","updates":[],"childrenPages":[]}

getList Locations

Retrieve a list of locations by client_id.

Query Params

client_id:
long
The ID of the end-client whose locations you'd like to fetch.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a2384dcd51b22d00f62454","project":"57041653ecfca80e00998f70","title":"Add Location","type":"post","version":"57041653ecfca80e00998f73","body":"","parentDoc":null,"category":"57a23741f724ae1900df4975","updates":[],"api":{"params":[{"ref":"","in":"body","required":true,"desc":"The end-client's ID.","default":"","type":"string","name":"client_id","_id":"57a2384dcd51b22d00f62464"},{"default":"","type":"string","name":"location_name","_id":"57a2384dcd51b22d00f62463","ref":"","in":"body","required":true,"desc":""},{"default":"","type":"string","name":"address1","_id":"57a2384dcd51b22d00f62462","ref":"","in":"body","required":true,"desc":""},{"default":"","type":"string","name":"address2","_id":"57a2384dcd51b22d00f62461","ref":"","in":"body","required":false,"desc":""},{"default":"","type":"string","name":"city","_id":"57a2384dcd51b22d00f62460","ref":"","in":"body","required":true,"desc":""},{"in":"body","required":true,"desc":"","default":"","type":"string","name":"state","_id":"57a2384dcd51b22d00f6245f","ref":""},{"desc":"","default":"","type":"string","name":"postal_code","_id":"57a2384dcd51b22d00f6245e","ref":"","in":"body","required":true},{"_id":"57a2384dcd51b22d00f6245d","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"country"},{"name":"location_type","_id":"57a2384dcd51b22d00f6245c","ref":"","in":"body","required":true,"desc":"See Constants >> Location Types","default":"","type":"int"},{"ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"first_name","_id":"57a2384dcd51b22d00f6245b"},{"in":"body","required":false,"desc":"","default":"","type":"string","name":"last_name","_id":"57a2384dcd51b22d00f6245a","ref":""},{"desc":"","default":"","type":"string","name":"title","_id":"57a2384dcd51b22d00f62459","ref":"","in":"body","required":false},{"_id":"57a2384dcd51b22d00f62458","ref":"","in":"body","required":false,"desc":"Flag indicating if this contact is a manager.","default":"","type":"boolean","name":"manager"},{"name":"phone_numbers[0]","_id":"57a2384dcd51b22d00f62457","ref":"","in":"body","required":false,"desc":"Phone number for the end-client","default":"","type":"string"},{"type":"string","name":"phone_numbers[0][ext]","_id":"57a2384dcd51b22d00f62456","ref":"","in":"body","required":false,"desc":"Phone number extension, if any","default":""},{"required":false,"desc":"The type of phone number","default":"","type":"string","name":"phone_numbers[0][type]","_id":"57a2384dcd51b22d00f62455","ref":"","in":"body"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/addressbook/clients/locations/add","auth":"required","examples":{"codes":[]},"method":"post"},"link_external":false,"link_url":"","user":"57041635473f900e004d5a35","createdAt":"2016-08-03T18:30:37.512Z","hidden":false,"githubsync":"","isReference":true,"order":1,"slug":"add-4","sync_unique":"","__v":0,"excerpt":"Create a new location and add to an existing client.","childrenPages":[]}

postAdd Location

Create a new location and add to an existing client.

Body Params

client_id:
required
string
The end-client's ID.
location_name:
required
string
address1:
required
string
address2:
string
city:
required
string
state:
required
string
postal_code:
required
string
country:
required
string
location_type:
required
integer
See Constants >> Location Types
first_name:
string
last_name:
string
title:
string
manager:
boolean
Flag indicating if this contact is a manager.
phone_numbers[0]:
string
Phone number for the end-client
phone_numbers[0][ext]:
string
Phone number extension, if any
phone_numbers[0][type]:
string
The type of phone number

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23ccbcd51b22d00f62472","githubsync":"","link_url":"","parentDoc":null,"project":"57041653ecfca80e00998f70","updates":[],"sync_unique":"","title":"Add Location Contact","version":"57041653ecfca80e00998f73","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"in":"body","required":true,"desc":"The location ID to add this contact to.","default":"","type":"string","name":"location_id","_id":"57a23a865220910e002a17ca","ref":""},{"desc":"","default":"","type":"string","name":"first_name","_id":"57a23a865220910e002a17c9","ref":"","in":"body","required":false},{"name":"last_name","_id":"57a23a865220910e002a17c8","ref":"","in":"body","required":false,"desc":"","default":"","type":"string"},{"ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"title","_id":"57a23a865220910e002a17c7"},{"default":"","type":"boolean","name":"manager","_id":"57a23c4bafc3050e000cf46a","ref":"","in":"body","required":false,"desc":"Flag indicating if this contact is a manager."},{"in":"body","required":false,"desc":"","default":"","type":"string","name":"emails[0]","_id":"57a23c4bafc3050e000cf469","ref":""},{"desc":"","default":"","type":"string","name":"emails[0][type]","_id":"57a23c4bafc3050e000cf468","ref":"","in":"body","required":false},{"_id":"57a23c4bafc3050e000cf467","ref":"","in":"body","required":false,"desc":"Phone number for the end-client.","default":"","type":"string","name":"phone_numbers[0]"},{"_id":"57a23c4bafc3050e000cf466","ref":"","in":"body","required":false,"desc":"Phone number extension, if any.","default":"","type":"string","name":"phone_numbers[0][ext]"},{"name":"phone_numbers[0][type]","_id":"57a23c4bafc3050e000cf465","ref":"","in":"body","required":false,"desc":"The type of phone number.","default":"","type":"string"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/addressbook/locations/contacts/add"},"createdAt":"2016-08-03T18:49:47.115Z","hidden":false,"isReference":true,"body":"","category":"57a23741f724ae1900df4975","excerpt":"Create a new contact and add to an existing client.","slug":"add-contact-1","user":"57041635473f900e004d5a35","__v":0,"link_external":false,"order":2,"type":"post","childrenPages":[]}

postAdd Location Contact

Create a new contact and add to an existing client.

Body Params

location_id:
required
string
The location ID to add this contact to.
first_name:
string
last_name:
string
title:
string
manager:
boolean
Flag indicating if this contact is a manager.
emails[0]:
string
emails[0][type]:
string
phone_numbers[0]:
string
Phone number for the end-client.
phone_numbers[0][ext]:
string
Phone number extension, if any.
phone_numbers[0][type]:
string
The type of phone number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a2387bcd51b22d00f62466","link_external":false,"order":0,"slug":"list-9","updates":[],"user":"57041635473f900e004d5a35","body":"","excerpt":"Fetch a list of contacts by client_id.","hidden":false,"title":"List Contacts","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57a238d0f724ae1900df4977","ref":"","in":"query","required":false,"desc":"The end-client's ID.","default":"","type":"string","name":"client_id"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/crm/contacts/list"},"category":"57a23863cd51b22d00f62465","link_url":"","__v":1,"isReference":true,"parentDoc":null,"project":"57041653ecfca80e00998f70","sync_unique":"","type":"get","version":"57041653ecfca80e00998f73","createdAt":"2016-08-03T18:31:23.082Z","githubsync":"","childrenPages":[]}

getList Contacts

Fetch a list of contacts by client_id.

Query Params

client_id:
string
The end-client's ID.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a239cad778850e0047e3c6","updates":[],"version":"57041653ecfca80e00998f73","category":"57a23863cd51b22d00f62465","link_external":false,"link_url":"","slug":"add-5","sync_unique":"","type":"post","api":{"method":"post","params":[{"desc":"The end-client's ID.","default":"","type":"string","name":"client_id","_id":"57a23a865220910e002a17ca","ref":"","in":"body","required":true},{"_id":"57a23a865220910e002a17c9","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"first_name"},{"_id":"57a23a865220910e002a17c8","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"last_name"},{"_id":"57a23a865220910e002a17c7","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"title"},{"_id":"57a23c4bafc3050e000cf46a","ref":"","in":"body","required":false,"desc":"Flag indicating if this contact is a manager.","default":"","type":"boolean","name":"manager"},{"_id":"57a23c4bafc3050e000cf469","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"emails[0]"},{"_id":"57a23c4bafc3050e000cf468","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"emails[0][type]"},{"name":"phone_numbers[0]","_id":"57a23c4bafc3050e000cf467","ref":"","in":"body","required":false,"desc":"Phone number for the end-client.","default":"","type":"string"},{"ref":"","in":"body","required":false,"desc":"Phone number extension, if any.","default":"","type":"string","name":"phone_numbers[0][ext]","_id":"57a23c4bafc3050e000cf466"},{"in":"body","required":false,"desc":"The type of phone number.","default":"","type":"string","name":"phone_numbers[0][type]","_id":"57a23c4bafc3050e000cf465","ref":""}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/addressbook/clients/contacts/add","auth":"required","examples":{"codes":[]}},"createdAt":"2016-08-03T18:36:58.040Z","hidden":false,"excerpt":"Create a new contact and add to an existing client.","githubsync":"","order":1,"parentDoc":null,"project":"57041653ecfca80e00998f70","__v":2,"body":"","title":"Add Contacts","user":"57041635473f900e004d5a35","isReference":true,"childrenPages":[]}

postAdd Contacts

Create a new contact and add to an existing client.

Body Params

client_id:
required
string
The end-client's ID.
first_name:
string
last_name:
string
title:
string
manager:
boolean
Flag indicating if this contact is a manager.
emails[0]:
string
emails[0][type]:
string
phone_numbers[0]:
string
Phone number for the end-client.
phone_numbers[0][ext]:
string
Phone number extension, if any.
phone_numbers[0][type]:
string
The type of phone number.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a228f2afc3050e000cf3ff","parentDoc":null,"sync_unique":"","category":"57a23625851a9a0e008cbdf0","link_external":false,"link_url":"","project":"57041653ecfca80e00998f70","slug":"statuses","updates":[],"user":"57041635473f900e004d5a35","body":"","isReference":true,"order":0,"githubsync":"","hidden":false,"createdAt":"2016-08-03T17:25:06.409Z","excerpt":"List of assignment statuses.","title":"Statuses","type":"get","version":"57041653ecfca80e00998f73","__v":0,"api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"errors\": [],\n    \"status_code\": 200,\n    \"version\": 1,\n    \"execution_time\": 0.014,\n    \"timestamp\": 1470265851\n  },\n  \"response\": [\n    {\n      \"id\": \"active\",\n      \"name\": \"Assigned\"\n    },\n    {\n      \"id\": \"cancelled\",\n      \"name\": \"Cancelled\"\n    },\n    {\n      \"id\": \"complete\",\n      \"name\": \"Complete\"\n    },\n    {\n      \"id\": \"declined\",\n      \"name\": \"Declined\"\n    },\n    {\n      \"id\": \"draft\",\n      \"name\": \"Draft\"\n    },\n    {\n      \"id\": \"exception\",\n      \"name\": \"Exception\"\n    },\n    {\n      \"id\": \"inprogress\",\n      \"name\": \"In Progress\"\n    },\n    {\n      \"id\": \"paid\",\n      \"name\": \"Paid\"\n    },\n    {\n      \"id\": \"paymentPending\",\n      \"name\": \"Invoiced\"\n    },\n    {\n      \"id\": \"refunded\",\n      \"name\": \"Refunded\"\n    },\n    {\n      \"id\": \"sent\",\n      \"name\": \"Sent\"\n    },\n    {\n      \"id\": \"void\",\n      \"name\": \"Voided\"\n    }\n  ]\n}"}]},"settings":"57a27847dba9ea0e0012c8ef","url":"/assignments/statuses","auth":"required","examples":{"codes":[]}},"childrenPages":[]}

getStatuses

List of assignment statuses.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"57a23641851a9a0e008cbdf1","hidden":false,"link_url":"","user":"57041635473f900e004d5a35","isReference":true,"link_external":false,"sync_unique":"","title":"Industries","category":"57a23625851a9a0e008cbdf0","createdAt":"2016-08-03T18:21:53.805Z","updates":[],"version":"57041653ecfca80e00998f73","excerpt":"Retrieve a list of industries.","parentDoc":null,"type":"get","githubsync":"","order":1,"project":"57041653ecfca80e00998f70","slug":"industries","__v":0,"api":{"examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"language":"text","code":""}]},"settings":"","url":"/constants/industries","auth":"required"},"body":"","childrenPages":[]}

getIndustries

Retrieve a list of industries.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23655f724ae1900df4974","parentDoc":null,"type":"get","__v":0,"api":{"url":"/constants/location_types","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"language":"text","code":""}]},"settings":""},"category":"57a23625851a9a0e008cbdf0","excerpt":"Retrieve a list of location types.","githubsync":"","version":"57041653ecfca80e00998f73","body":"","hidden":false,"link_external":false,"link_url":"","sync_unique":"","title":"Location Types","createdAt":"2016-08-03T18:22:13.084Z","isReference":true,"project":"57041653ecfca80e00998f70","order":2,"slug":"location-types","updates":[],"user":"57041635473f900e004d5a35","childrenPages":[]}

getLocation Types

Retrieve a list of location types.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"57a23667d778850e0047e3b7","excerpt":"Retrieve a list of dress codes.","link_external":false,"order":3,"updates":[],"title":"Dress Codes","api":{"settings":"","url":"/constants/dress_codes","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"language":"text","code":""}]}},"body":"","category":"57a23625851a9a0e008cbdf0","createdAt":"2016-08-03T18:22:31.283Z","link_url":"","githubsync":"","parentDoc":null,"project":"57041653ecfca80e00998f70","sync_unique":"","type":"get","user":"57041635473f900e004d5a35","version":"57041653ecfca80e00998f73","__v":0,"hidden":false,"isReference":true,"slug":"dress-codes","childrenPages":[]}

getDress Codes

Retrieve a list of dress codes.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}