{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b8cfece0-afba-4926-8527-20412f98fc46","name":"Locumsmart API Documentation","description":"<img src=\"https://s3.amazonaws.com/locumsmart.images/logos/locumsmart_logo_large.svg\">\n\nWelcome to the Locumsmart API! The following setup should be performed by an Integration Contact - a technical point person who's contact information is shared with both development and support.\n\n# In App Setup\n\n<img src=\"https://s3.amazonaws.com/locumsmart.images/documentation/api_integration.gif\">\n\nMake sure the API feature is enabled by navigating to _Administration > Features_. If your API Access is turned to **Off**, reach out to your LS API Contact to enable this.\n\nOnce API Access is turned on, the organization will have access to the _Administration > Integration_ menu option, which you can verify to ensure the feature was enabled correctly.\n\n# Integration\n\nNavigate to _Administration > Integration_ to begin setting up Webhooks and to find the two pieces of information needed to Authenticate:\n\n1. **API User**\n    \n2. **Secret Access Key**\n    \n\nThe first time navigating to the Integration page will present the user with a _Generate Secret_ button. To generate a shared secret for the **API User** that has already been created for you, click Generate Secret. This secret is not known to Locumsmart and cannot be recovered, so it should be stored in a secure location. You can generate a new secret at any time if you lose access to it, but you will need to update any services you may have already configured with the original secret.\n\n# Webhook Configuration\n\n<img src=\"https://s3.amazonaws.com/locumsmart.images/documentation/webhook_setup.gif\">\n\nTo configure a webhook, from the Administration > Integration page, click the _Add_ button for the Webhook Subscriptions section. This will create a new subscription, with a required Title and Endpoint. The endpoint should be publicly accessible and configured to allow POST requests.\n\nAfter saving the subscription from the first time, a unique key will be generated – this is a secret key that allows you to evaluate messages received to the public endpoint to ensure they are from Locumsmart. This key is unique per subscription, so you can also configure multiple subscriptions for the same endpoint and use the key to route messages if desired.\n\n## Available Webhooks\n\n| Webhook | Action | Description |\n| --- | --- | --- |\n| Providers | Created | Sends a message when a new Provider record is created in the system |\n|  | Updated | Sends a message when a Provider in the system is updated |\n| Assignments | Received | Sends a message when an Assignment is sent to your Organization |\n|  | Updated | Sends a message when a previously received Assignment is updated |\n| Bids | Accepted | Sends a message when a Bid you presented for an Assignment is Accepted |\n|  | Declined | Sends a message when a Bid you presented for an Assignment is declined |\n|  | Canceled | Sends a message when a Bid you presented for an Assignment is canceled |\n| Confirmation Agreements | Created | Sends a message when a new confirmation agreement is moved to a ‘Pending’ status – usually as a result of an accepted bid, but also if an active agreement is moved back to pending |\n|  | Updated | Sends a message when contacts or dates on an agreement are changed |\n|  | Moved to Active | Sends a message when the agreement is moved to ‘Active’ status |\n|  | Moved to Past | Sends a message when the agreement is moved to ‘Past’ status |\n|  | Canceled | Sends a message when the agreement is canceled |\n| Propose Changes (Agreement Amendments) | Created | Sends a message when changes are proposed to an agreement |\n|  | Updated | Currently unused, you cannot modify changes (you must cancel and resubmit) |\n|  | Accepted | Sends a message when proposed changes are accepted |\n|  | Declined | Sends a message when proposed changes are declined |\n|  | Canceled | Sends a message when proposed changes are canceled |\n| Timesheets | Submitted | Sends a message when a Timesheet is submitted, or when a provider requests approval for an MTC sheet before it is submitted to the HCO |\n|  | Updated | Sends a message when a Timesheet is updated |\n|  | Approved | Sends a message when a Timesheet is approved |\n|  | Rejected | Sends a message when a Timesheet is rejected |\n| Invoice | Approved | Sends a message when an Invoice is approved |\n|  | Rejected | Sends a message when an Invoice is rejected |\n|  | Paid | Sends a message when an Invoice has any or all Line Item that was previously approved is now paid |\n\n# Rate Limits\n\nIn an effort to maintain performance as our platform grows, Locumsmart is introducing Rate Limiting to our API endpoints so that all customers have the best experience. Consumers of our API should expect to receive a `429 Too Many Requests` response code when they make more than the following number of calls within one minute:\n\n1. Global Limit: 40\n    \n2. Some endpoints will have a lower limit, see specific endpoint documentation for details\n    \n\nWe will also include the following Header data:\n\n| **HTTP Header** | **Description** |\n| --- | --- |\n| Rate-Limited | Value, in seconds, when tokens will reset |\n\nAs of now, the only call with a different limit is the POST to `/Provider`, which has a limit of 10 calls per minute.\n\n# Sandbox Environment\n\nFor development of integrations, Locumsmart has made available to you a ‘sandbox’ environment, located at [https://sandbox.locumsmart.net/](https://sandbox.locumsmart.net/) with corresponding API endpoints at [https://sandbox-api.locumsmart.net](https://sandbox-api.locumsmart.net)\n\nThis environment should be considered volatile - the data contained in it may be refreshed, reset, deleted, or changed without prior notice from Locumsmart. Generally, you can rely on this process to occur outside of normal business hours (M-F 8A – 8P Central) but in rare circumstances it may occur at other times. LocumsMart will attempt to inform you in advance if an update is going to occur, via the Integration Contact you supplied during Integration onboarding.\n\nYour user accounts from the live environment will be accessible in this environment, as well as a copy of your data from the live site, pending refreshes as outlined above.\n\n**Warning**  \nThe shared secret for your API account is not shared from the live environment and may be reset during scheduled or unscheduled refreshes.\n\n## LS API Contact\n\nName: Eric Pelkey  \nEmail: [api@locumsmart.net](https://mailto:api@locumsmart.net)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16591391","team":2597853,"collectionId":"b8cfece0-afba-4926-8527-20412f98fc46","publishedId":"2sA3XMjNy6","public":true,"publicUrl":"https://apidocs.locumsmart.net","privateUrl":"https://go.postman.co/documentation/16591391-b8cfece0-afba-4926-8527-20412f98fc46","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.9","publishDate":"2024-06-11T18:04:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Doc Environment","id":"27783cec-b5a6-4108-8515-9d8bdc5f6b69","owner":"16591391","values":[{"key":"baseUrl","value":"https://api.locumsmart.net","enabled":true,"type":"default"},{"key":"api_user","value":"","enabled":true,"type":"default"},{"key":"api_secret","value":"","enabled":true,"type":"secret"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/95e7ff8572949371bf03dc55f4520314a3baf787de539e644204ec083b43d9ef","favicon":"https://locumsmart.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Doc Environment","value":"16591391-27783cec-b5a6-4108-8515-9d8bdc5f6b69"}],"canonicalUrl":"https://apidocs.locumsmart.net/view/metadata/2sA3XMjNy6"}