Docs/API Reference

API Reference

All endpoints are available at https://api.nordax.ai. Authentication is required for write operations and private data. See Authentication for details.

Response Format

All endpoints return JSON. Successful responses include a data key. Errors include an error key with a human-readable message.

Success (200)

{
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

Error (4xx)

{
  "error": "Entity not found"
}

Entities

GET/v1/entities

List published entities with search, filter, and pagination.

?q=&category=&city=&state=&page=&limit=

GET/v1/entities/:slug

Get full entity data by slug.

?format=jsonld

GET/v1/entities/:slug/schema

Get raw JSON-LD structured data for an entity.

GET/v1/entities/:slug/score

Get computed AI Visibility Score.

GET/v1/entities/:slug/score-signals

Get score signal categories.

GET/v1/entities/resolve

Resolve an entity by domain URL.

?domain=example.com

POST/v1/entities/:slug/claim

Initiate a claim request for a seeded entity.

Search

GET/v1/search

Full-text entity search with filters and pagination.

?q=&category=&city=&state=&page=&limit=

Organizations

GET/v1/organizations/:slug

Get an organization with its child entities.

Categories & Stats

GET/v1/categories

List entity categories with counts.

GET/v1/stats

Get network-wide statistics (total entities, verified count, etc.).

Webhooks

GET/v1/webhooks

List your webhook subscriptions.

POST/v1/webhooks

Create a webhook subscription for score/entity events.

DELETE/v1/webhooks/:id

Delete a webhook subscription.

Example: Get Entity

GET /v1/entities/nordax-digital

{
  "data": {
    "slug": "nordax-digital",
    "entityName": "Nordax Digital",
    "entityType": "ProfessionalService",
    "description": "AI-powered entity verification...",
    "email": "info@nordax.ai",
    "url": "https://nordax.ai",
    "city": "Denver",
    "state": "CO",
    "country": "US",
    "tier": "gold",
    "verificationStatus": "verified",
    "visibilityScore": 92,
    "services": ["AI Entity Verification", "..."],
    "sameAs": ["https://linkedin.com/company/..."],
    "updatedAt": "2026-03-15T..."
  }
}

Pagination

List endpoints support page and limit query parameters. Defaults: page=1, limit=20, max limit=100.

GET /v1/entities?page=2&limit=50&category=Restaurant&city=Denver

Entities

GET/v1/entities

List published entities with search, filter, and pagination.

?q=&category=&city=&state=&page=&limit=

GET/v1/entities/:slug

Get full entity data by slug.

?format=jsonld

GET/v1/entities/:slug/schema

Get raw JSON-LD structured data for an entity.

GET/v1/entities/:slug/score

Get computed AI Visibility Score.

GET/v1/entities/:slug/score-signals

Get score signal categories.

GET/v1/entities/resolve

Resolve an entity by domain URL.

?domain=example.com

POST/v1/entities/:slug/claim

Initiate a claim request for a seeded entity.

Example: Get Entity

GET /v1/entities/nordax-digital

{
  "data": {
    "slug": "nordax-digital",
    "entityName": "Nordax Digital",
    "entityType": "ProfessionalService",
    "description": "AI-powered entity verification...",
    "email": "info@nordax.ai",
    "url": "https://nordax.ai",
    "city": "Denver",
    "state": "CO",
    "country": "US",
    "tier": "gold",
    "verificationStatus": "verified",
    "visibilityScore": 92,
    "services": ["AI Entity Verification", "..."],
    "sameAs": ["https://linkedin.com/company/..."],
    "updatedAt": "2026-03-15T..."
  }
}