Documentation

Welcome to Middesk! Get familiar with the Middesk API by exploring the documentation:

Welcome



Welcome to the Middesk Developer Docs! Whether you're looking to use our REST APIs, receive notifications with webhooks, or just learn more about the mechanics of how Middesk works, you've come to the right place.

We'll start by covering some high-level concepts and help you get set up with a developer workspace, so you can begin integrating with Middesk.

If you have any questions along the way, please don't hesitate to reach out to us directly via email at support@middesk.com.

Step 1: Obtain your API key

Middesk authenticates your API requests using your unique API key. If you do not include your key when making an API request or use one that is incorrect or outdated, Middesk returns an error.

You can receive your API key by contacting support@middesk.com.

The API keys included in our docs are all randomly generated so be sure to replace these with your own.

Step 2: Make an API request

To check that your integration is working correctly, make an API request using your API key to create a business.

curl https://api.middesk.com/v1/businesses \
  -u mk_live_50e41b726c05c15cbf8bc13f: \
  --header "Accept: application/json" \
  -X POST \
  -d name=Middesk \
  -d tin[tin]=123410000 \
  -d website[url]=https://www.middesk.com \
  -d addresses[0][address_line1]=2180+Bryant+St \
  -d addresses[0][address_line2]=Unit+210 \
  -d addresses[0][city]=san+francisco \
  -d addresses[0][state]=CA \
  -d addresses[0][postal_code]=94110

After creating a business, you will receive a response from our API to confirm the creation of that business.

{
  "object": "business",
  "id": "5966eefe-7ba5-4e98-9f95-1e8d0bca6ec6",
  "name": "Middesk",
  "created_at": "2019-02-04T18:17:20.421Z",
  "updated_at": "2019-02-04T18:17:20.421Z",
  "status": "open",
  "addresses": [
    {
      "object": "address",
      "address_line1": "2180 Bryant St",
      "address_line2": "Unit 210",
      "city": "san francisco",
      "state": "CA",
      "postal_code": "94110",
      "full_address": "2180 Bryant St, Unit 210, san francisco, CA 94110",
      "created_at": "2019-02-04T18:17:20.533Z",
      "updated_at": "2019-02-04T18:17:20.533Z"
    }
  ],
  "website": {
    "url": "https://www.middesk.com"
  },
  "tin": {
    "tin": "12-3410000"
  }
}

Once you have successfully made an API request to create a Business and received a successful response, you’re ready to begin integrating Middesk.

Questions?

We're always happy to help with code or other questions you might have! Feel free to reach out to support@middesk.com.


What's Next

Learn more about the core concepts used throughout the Middesk platform.

Introduction to Middesk