DocsAPI ReferenceAbout
DocsAPI ReferenceAbout
  1. Docs
  • Overview
  • Getting Started
  • Authentication
  • Permissions
  • API Reference
    • locations
      • List locations
      • Create a location
      • Get a location
      • Update a location by UUID
      • Delete a location
    • users
      • List users
      • Create a new user
      • Get a user
      • Delete a user
    • groups
      • List groups
      • Create a new group
      • Get a group
      • Update a group
      • Delete a group
    • assets
      • List assets
      • Get single asset
    • products
      • List products
  1. Docs

Authentication

The Marvia API uses secure API keys to authenticate and authorize access to its services. API keys allow you to interact with Marvia’s API and are required for all API requests.Every request to the Marvia API must include an API key in the Authorization header.

Requirements#

To generate and use API keys, you must:
Have an active Marvia account
Have access to the Marvia Admin Dashboard
If you do not have an account or are a new customer, please reach out to our support team at support@getmarvia.com. They will guide you through the setup process and help you get started.

Generating a Staging API Key#

Follow these steps to generate an API key for testing in the staging environment:

Step 1: Log In#

Go to the Marvia Admin Dashboard:
Eg: https://demo.getmarvia.com/new/admin
Use your admin credentials to log in.

Step 2: Navigate to Marvia API Settings#

Navigate to the sidebar and click Settings
Go to Connections → Marvia API
Navigate to Marvia API Settings

Step 3: Generate a New API Key#

Click on the Generate New API Key button
Generate a New API Key Page
Provide a name for your key (e.g., “Staging Client App”, “Test Integration”)
Click Generate, then your new API key will be generated and displayed.
Generate a New API Key Modal.

Step 4: Copy and Secure the Key#

Copy the key immediately
Important: The API key will only be shown once. For security reasons, you won't be able to view it again.
Copy key.
Store it securely (e.g., in an environment variable, secrets manager, or encrypted config file)
Do not share or expose your key publicly
If you lose the key, you’ll need to generate a new one by repeating the above steps.

Step 5: Lost or Regenerating a Key#

If the API key is lost, no worries — simply return to the Marvia Admin dashboard and generate a new one following the same steps above.
You can also delete / revoke the lost key as shown below.
Deleting a key.

Requesting a Production API Key#

To use Marvia API in production, you’ll need a production-grade API key.
Production keys are not self-generated. To obtain one:
Contact the support team at support@getmarvia.com
Mention your account name and the purpose (e.g., “Live integration for client portal”)
The team will review your request and issue a production API key if approved
Best Practice: Use a staging key for testing and integration. Once you are ready to deploy to production, you can request for a production api key.

Making Authenticated API Requests#

All API requests must:
Use HTTPS
Include your API key in the Authorization header

Example Request#

Modified at 2025-07-14 12:52:11
Previous
Getting Started
Next
Permissions
Built with