Applications API

Manage applications programmatically through the SearchX REST API.

Overview

The Applications API allows you to create, read, update, and manage your SearchX applications programmatically. This is useful for automated provisioning and integration with your backend systems.

Endpoints

List Applications

GET /api/v1/applications

Returns a list of all applications in your organization.

Response:

{
  "data": [
    {
      "id": "app_abc123",
      "name": "My Store Search",
      "feed_url": "https://mystore.com/feed.xml",
      "feed_type": "google",
      "products_count": 1250,
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-03-01T14:20:00Z"
    }
  ]
}

Get Application

GET /api/v1/applications/{id}

Returns details for a specific application.

Create Application

POST /api/v1/applications

Request Body:

{
  "name": "My New Store",
  "feed_url": "https://mystore.com/feed.xml",
  "feed_type": "google"
}

Parameters:

Update Application

PUT /api/v1/applications/{id}

Update application details. Accepts the same parameters as create.

Import Products

POST /api/v1/applications/{id}/import

Triggers a product import from the configured XML feed.

Authentication

All API requests require authentication headers. See Authentication for details.