Skip to main content
Create an API key in the Nash Portal and grab the Organization ID you’ll send in the Nash-Org-Id header — the two pieces every API request needs.

​
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, which lists all API keys you’ve created. 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’re registered in multiple organizations, choose which organizations the key can access — the organization you’re currently logged into is preselected. Then select the features the key may use. A key can never do more than you can: if you don’t have access to a feature in a particular organization, the key won’t have it there either, regardless of the permissions you’ve 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