---
title: "REST API User Guide"
slug: "rest-api-user-guide"
updated: 2025-04-28T06:12:03Z
published: 2025-04-28T06:12:03Z
canonical: "docs.connect.netmoregroup.com/rest-api-user-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connect.netmoregroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API User Guide

The following article describes how the REST based API for Netmore Connect works and provides examples of the most basic API calls.

## Online Documentation

The online documentation of the REST API contains information regarding all exposed calls, their parameters and possible return values. The online documentation generated by Swagger can be found here: [https://api.connect.netmoregroup.com/docs/](https://api.connect.netmoregroup.com/docs/)

## API Token

The first thing to do when using the API is to generate an API Key for subsequent API calls This is done in the [web frontend](https://app.connect.netmoregroup.com/) under your customer.

![](https://cdn.document360.io/58c1b868-b36b-492e-aea3-32180613f31f/Images/Documentation/image-1745398363063.png)

API calls must have the “api-key” header added for authorization to work, see below for examples:

| ```shell curl \ 'https://api.connect.netmoregroup.com/api/v1/customers/{customerId}' \ -X GET \ -H 'Accept: application/json' \ -H 'api-key: {apiKey}' ``` | ```powershell Invoke-WebRequest ` -Uri "https://api.connect.netmoregroup.com/api/v1/customers/{customerId}" ` -Method 'GET' ` -Headers @{'Accept' = 'application/json'; 'api-key' = '{apiKey}'} ` \| Select-Object -Expand RawContent ``` |
| --- | --- |