# Client Admin API

Welcome to the novti Client Admin API documentation. This API provides authenticated access to your tenant admin data.

# Base URL

https://api.admin.novti.io

# Available Resources

Resource	Description	Scope Required
Pages	Retrieve and filter your pages	`read:pages`
Forms	Retrieve your forms	`read:forms`
Organization	Retrieve your organization details	`read:organization`

# Quick Start

# 1. Obtain Credentials

Visit the novti Client Dashboard (opens new window) to create developer credentials. When creating credentials, select at least one scope based on the resources you need to access.

# 2. Authentication

All API requests require authentication using OAuth2 client_credentials grant type. Include your credentials as query parameters:

Parameter	Required	Description
`client_id`	Yes	Your developer client ID
`client_secret`	Yes	Your developer client secret
`grant_type`	Yes	Must be `client_credentials`

# 3. Make Your First Request

curl -X GET 'https://api.admin.novti.io/pages?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'

# Response Format

All API responses follow a consistent JSON structure:

{
  "status": "Success",
  "data": { ... },
  "meta": {
    "size": 1
  }
}

# Status Values

Status	Description
`Success`	Request completed successfully
`Error`	An error occurred while processing the request
`Not Found`	The requested resource was not found

# Meta Object

The meta object contains additional information about the response:

Field	Description
`size`	Number of items returned

# Error Handling

When an error occurs, the API returns an appropriate HTTP status code and an error response:

{
  "status": "Error",
  "message": "Error description",
  "statusCode": 500
}

# Common HTTP Status Codes

Code	Description
`200`	Success
`401`	Unauthorized - Invalid or missing credentials
`403`	Forbidden - Insufficient scope permissions
`404`	Not Found - Resource does not exist
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error

# Rate Limiting

The API implements rate limiting to ensure fair usage. Requests exceeding the limit will receive a 429 status code.

# Scopes

Scopes control access to specific resources. Available scopes:

Scope	Access
`read:pages`	Read access to Pages
`read:forms`	Read access to Forms
`read:organization`	Read access to Organization

# Next Steps

Learn more about Pages
Learn more about Forms
Learn more about Organization