Skip to main content

​
RESTful API

The API follows RESTful conventions and uses JSON for both requests and responses. We assume that requests with a payload contain properly formatted JSON, but we still recommend setting the Content-Type header to application/json.

​
API protocols and headers

The Nash API uses standard HTTP methods and HTTP response codes to indicate status and errors. Every Nash API response includes a request ID, whether the request succeeded or failed (see Errors). For faster support, include the request ID when contacting support regarding a specific API call. All requests are strictly HTTPS.

​
Enabling your API access

Your organization’s API will be enabled in Sandbox automatically (portal.sandbox.usenash.com). When you are ready for Production testing, please reach out to support@usenash.com to enable the API in Production.

​
Generating your API key from the Nash Portal

Go to your Settings page by clicking this option in the Nash Portal sidebar. Nash Portal Settings Page Select API. This will redirect you to the API Settings and will contain all API Keys created by you. API Settings Page Once you are there, click on Generate Key. Generate Key Page Add a key name (mandatory) and description (optional) to help you identify the API Key later. If you are registered in multiple organizations, you’ll have the chance to select which organizations you want to scope this key with in the selector. We will preselect the current organization to which you are logged in. Make sure to also add all features you want this key to have access to. Adding a feature to a key does not guarantee the key’s access to that feature under the organizations you’ve selected. If you, the user, do not have access to that feature in a particular organization, then your key won’t be able to access it either, regardless of which permissions you have placed on the key. Generate Key Page 2 After you’re done, click Save and your API Key will be created. Make sure to copy and store it because this will be the only time you’ll have access to view your key. Confirmation Page

​
Retrieving and using an organization ID

Now that you created your API Key, you’ll need the ID of the organization you want to read or write information for. We call this Org ID. You pass it on endpoints that act on an organization’s resources, such as creating a job, with the Nash-Org-Id header — for example, "Nash-Org-Id": "org_AbC123" to create a job within org_AbC123. When you need it:
  • Required when your API key has access to more than one organization — the header tells Nash which org the request is for. Without it, a multi-org request is rejected.
  • Optional when your key is scoped to a single organization — Nash already knows which org the key belongs to.
We recommend including Nash-Org-Id in your examples and request templates regardless, so the same code works whether a key is later granted access to additional organizations. To retrieve the Org ID, hover over an organization listed on the key and copy its ID. Org ID Page