Skip to main content
GET
/
import-definitions
/
{id}
Get import definition
curl --request GET \
  --url https://app.azalt.co/api/v1/import-definitions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "inputSchema": [
    {
      "name": "<string>",
      "type": "string",
      "required": false,
      "aliases": [
        "<string>"
      ],
      "role": "site_identifier"
    }
  ],
  "processorCode": "<string>",
  "outputSchema": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "string",
      "periodUnit": "YEARLY",
      "formId": "<string>",
      "formElementId": "<string>",
      "formElementKey": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Successful response

id
string
required
organizationId
string | null
required
name
string
required
description
string | null
required
inputSchema
object[]
required
Minimum array length: 1
processorCode
string
required
outputSchema
object[]
required
Minimum array length: 1
createdAt
string
required
updatedAt
string
required