Introduction
Manage your resources and automate workflows using the Platform API.
Nekt’s Platform API helps organizations streamline data operations and gain valuable insights. It enables teams to build integrations that maximize the value of their Nekt implementation.
Automate Workflows
You can integrate with your own systems to automate workflows:
- Schedule regular data extraction
- Trigger pipelines based on external events
- Build custom dashboards or monitoring solutions
- Integrate Nekt with your existing tools and services
Base URL
The API is built on REST conventions with predictable URL structure, uses standard HTTP response codes, authentication and verbs, and returns JSON responses.
All requests must be made against:
We enforce HTTPS in every request to improve data security, integrity, and privacy.
Authentication
The Nekt API uses API keys to authenticate requests. To authenticate, you need to add an x-api-key
header with your API key as the value:
Your API key carries admin-level privileges, so be sure to keep it secure! Do not share your API key in publicly accessible areas such as GitHub, client-side code, and so forth.
Create an API key
Go to your Workspace settings and create an API Key, it will be necessary to use all endpoints.
Expanding Responses
Many objects allow you to request additional information as an expanded response by using the expand
request parameter. This parameter is available on all API requests, and applies to the response of that request only.
The expandable label in this documentation indicates ID fields that you can expand into objects. When an object contains the ID of a related object in its response properties, you can expand these objects in line with the expand
request parameter.
Check Expanding Responses for details.