HydraCore
API by router

Sheet import

Import Sheet To Entities

POST
/internal/v1/instances/{instance_id}/import/sheet-to-entities

Path Parameters

instance_idInstance Id
Formatuuid

Request Body

column_mapColumn Map

Map column letters/indices to data fields. E.g. {'A': 'name', 'B': 'client', 'C': 'location'}

Empty Object

connection_name?Connection Name
customer_idCustomer Id
Formatuuid
definition_slugDefinition Slug

Entity definition slug (e.g. 'site')

has_header?Has Header
Defaulttrue
range?Range
Default"Sheet1"
spreadsheet_idSpreadsheet Id
tags?Tags

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/sheet-to-entities" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "definition_slug": "string",    "spreadsheet_id": "string"  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Import Sheet To Staff

POST
/internal/v1/instances/{instance_id}/import/sheet-to-staff

Path Parameters

instance_idInstance Id
Formatuuid

Request Body

column_mapColumn Map

Map column letters/indices to staff fields. E.g. {'A': 'name', 'B': 'phone', 'C': 'email', 'D': 'skills'}

Empty Object

connection_name?Connection Name
customer_idCustomer Id
Formatuuid
has_header?Has Header

First row is header (skip it)

Defaulttrue
range?Range

A1 notation range

Default"Sheet1"
spreadsheet_idSpreadsheet Id

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/sheet-to-staff" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "spreadsheet_id": "string"  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Csv Import Entities

Import entity records from CSV/paste data. Tenant dashboard.

POST
/v1/customers/{customer_id}/import/csv-to-entities

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

column_mapColumn Map
Propertiesproperties <= 26

Empty Object

definition_slugDefinition Slug
has_header?Has Header
Defaulttrue
rowsRows

2D array (max 10K rows)

Itemsitems <= 10000
tags?Tags

Response Body

curl -X POST "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/csv-to-entities" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "definition_slug": "string",    "rows": [      [        "string"      ]    ]  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Csv Import Staff

Import staff from CSV/paste data (2D array). Tenant dashboard.

POST
/v1/customers/{customer_id}/import/csv-to-staff

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

column_mapColumn Map

Map column indices to staff fields (max 26 columns). E.g. {'0': 'name', '1': 'phone'}

Propertiesproperties <= 26

Empty Object

has_header?Has Header
Defaulttrue
rowsRows

2D array of row data (max 10K rows)

Itemsitems <= 10000

Response Body

curl -X POST "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/csv-to-staff" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "rows": [      [        "string"      ]    ]  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant Import Sheet To Entities

Import entity records from a Google Sheet. Auth: JWT (admin only).

POST
/v1/customers/{customer_id}/import/sheet-to-entities

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

column_mapColumn Map

Empty Object

connection_name?Connection Name
definition_slugDefinition Slug
has_header?Has Header
Defaulttrue
range?Range
Default"Sheet1"
spreadsheet_idSpreadsheet Id
tags?Tags

Response Body

curl -X POST "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/sheet-to-entities" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "definition_slug": "string",    "spreadsheet_id": "string"  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant Import Sheet To Staff

Import staff from a Google Sheet. Auth: JWT (admin only).

POST
/v1/customers/{customer_id}/import/sheet-to-staff

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customer_idCustomer Id
Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

column_mapColumn Map

Empty Object

connection_name?Connection Name
has_header?Has Header
Defaulttrue
range?Range
Default"Sheet1"
spreadsheet_idSpreadsheet Id

Response Body

curl -X POST "https://loading/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/import/sheet-to-staff" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "column_map": {},    "spreadsheet_id": "string"  }'
{
  "errors": [
    "string"
  ],
  "imported": 0,
  "skipped": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Shared hosting internal

Previous Page

Smoke

Next Page