Quick Start
Get up and running with the Nomad Media API in minutes.
Quick Start
This guide walks you through everything you need to make your first Nomad Media API call — authentication, your first request, and the core patterns used throughout every integration.
Prerequisites
You will need five values to connect to the Nomad Media API. These are provided by Nomad when your environment is provisioned:
| Value | Description |
|---|---|
| API URL | The base URL for your environment's Admin API (e.g. https://admin-app.{CLIENT_DOMAIN}) |
| Username | Your integration service account email address |
| Password | Your integration service account password |
| API Type | Always admin for server-to-server integrations |
| Debug mode | Optional — set to true for verbose logging during development |
Admin API vs. Portal API Nomad Media exposes two API surfaces. The Admin API covers all data management, asset management, configuration, and integration operations. The Portal API is for end-user-facing experiences such as the public content portal. For all developer integrations, always use the Admin API.
Step 1: Authenticate
Call the login endpoint with your credentials to receive a JWT bearer token. All subsequent API calls must include this token in the Authorization header.
POST https://admin-app.{CLIENT_DOMAIN}/api/account/login
Content-Type: application/json
{
"email": "[email protected]",
"password": "your-password"
}
The response includes an authorizationToken (the bearer token) and a refreshToken. Tokens are valid for approximately 45 minutes. Use the refresh endpoint to renew without re-authenticating.
See Authentication for full details including the refresh flow and static API token option.
Store credentials securely. Treat your service account email and password like an access key/secret pair — store them in a secrets manager (AWS Secrets Manager, Azure Key Vault, etc.), fetch them at runtime, perform login, and keep only the resulting JWT in session memory. Never hardcode credentials in source code.
Step 2: Understand the API Pattern
Almost every API call in Nomad Media is built around two identifiers:
- Content Definition ID — identifies which type of content you are working with (e.g. the "Committee" schema, the "Meeting" schema). Think of this as the table name in a database.
- Content Record ID — identifies a specific record within that content definition. This is the UUID assigned to the individual item.
Data is passed and returned as a property bag — a flat JSON key/value object where each key is the propertyName configured for that field in the Site Manager. For relationship fields, the value is the UUID of the related record.
GET /admin/content/{contentDefinitionId} → list records
GET /admin/content/{contentDefinitionId}/{id} → get a single record
POST /admin/content/{contentDefinitionId} → create a record
PUT /admin/content/{contentDefinitionId}/{id} → update a record
DELETE /admin/content/{contentDefinitionId}/{id} → delete a record
See Your First API Call for working code examples in JavaScript and Python.
Step 3: Discover API Calls Using the Admin UI
You don't need to guess the right endpoint or payload — the Admin UI uses the exact same REST API you will use as a developer. To find the API call for any operation:
- Open the Nomad Media Admin UI in your browser
- Open your browser's developer tools (F12) and switch to the Network tab
- Perform the action you want to automate (create a record, run a search, update a field, etc.)
- Inspect the outgoing network request to see the exact endpoint URL, HTTP method, and request body
This is the fastest way to confirm the correct payload structure for any operation when documentation is unclear.
Next Steps
- Authentication — token management, refresh flow, and static API tokens
- Your First API Call — working code examples for create, read, search, and update
- Key Concepts — content definitions, field types, UUIDs, and the data model
- SDKs — Python, JavaScript, and Java SDKs that handle auth and token refresh automatically
