Editor

The Editor object

An Editor object has the following identifiers:

• id : string - The unique identifier of an editor

Delete an editor message

Permanently delete an editor message.

Arguments:

• editor - The identifier of the editor
• message - The identifier of the editor message to be deleted

Response object:

This method returns an object with no properties.

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    -X DELETE \
    "${JACKDB_API_URL}/editor/ERKdCGa8risSJqodUxa0Z4Dn/message/28d150aa-8e6d-496f-8bd1-a57d818b8a7a"

Example response:

{}

List editor messages

Returns a list of all messages for a specific editor.

Arguments:

• editor - The identifier of the editor to be retrieved

Response object:

• An array of Editor Message objects
• Each entry in the array is an object with the following properties:
  • id - string : The unique identifier of the message
  • editorId - string : The unique identifier of the editor
  • createdAt - timestamp : When the editor was created
  • title - string : The title of the message
  • message - string : The body of the message

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    "${JACKDB_API_URL}/editor/ERKdCGa8risSJqodUxa0Z4Dn/message"

Example response:

[
  {
    "id": "28d150aa-8e6d-496f-8bd1-a57d818b8a7a",
    "createdAt": "2026-01-21T19:49:38.432Z",
    "editorId": "ERKdCGa8risSJqodUxa0Z4Dn",
    "title": "Hello",
    "message": "Hello from the API"
  }
]

List all editors

Returns a list of all editors.

Arguments:

This method has no additional arguments.

Response object:

• An array of Editor objects
• Each entry in the array is an object with the following properties:
  • id - string : The unique identifier of the data source
  • dataSource - object : The Data Source object onto which this editor is connected
    • id - string : The unique identifier of the data source
    • name - string : The name of the data source
    • alias - string : The alias of the data source
  • person - object : The Person object to who created this editor
    • id - string : The unique identifier of the person
    • name - string : The name of the person
    • username - string : The username of the person
    • email - string : The email address of the person
  • createdAt - timestamp : When the editor was created
  • updatedAt - timestamp : When the editor was last updated

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    "${JACKDB_API_URL}/editor"

Example response:

[
  {
    "id": "ERV6ThdNrEQt2b0fqAAidrTL",
    "dataSource": {
      "id": "DUGC6IqGQ4DX00Lt0",
      "name": "General Ledger",
      "alias": "gl-prod"
    },
    "person": {
      "id": "P7ueWXlRjejZU3Yzt",
      "name": "Alexia Buckner",
      "username": "abuckner",
      "email": "alexia.buckner@example.com"
    },
    "createdAt": "2025-03-13T13:57:07.858Z",
    "updatedAt": "2025-03-13T14:27:07.858Z"
  },
  {
    "id": "ERLBu3DV0TF0eqfv3knRfL2J",
    "dataSource": {
      "id": "DUGC6IqGQ4DX00Lt0",
      "name": "General Ledger",
      "alias": "gl-prod"
    },
    "person": {
      "id": "PTbjsa5vR6Hu5aIT5",
      "name": "Zayne Tran",
      "username": "ztran",
      "email": "zayne.tran@example.com"
    },
    "createdAt": "2025-03-13T13:57:28.216Z",
    "updatedAt": "2025-03-14T15:21:28.132Z"
  }
]

Publish an editor message

Publishes a message to an editor.

Arguments:

• editor - The identifier of the editor to be retrieved
• title - string : The title of the message
• message - string : The body of the message

Response object:

• An Editor Message object with the following properties:
  • id - string : The unique identifier of the message
  • editorId - string : The unique identifier of the editor
  • createdAt - timestamp : When the editor was created
  • title - string : The title of the message
  • message - string : The body of the message

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    --data '{"title": "Hello", "message": "Hello from the API"}' \
    "${JACKDB_API_URL}/editor/ERKdCGa8risSJqodUxa0Z4Dn/message"

Example response:

{
  "id": "28d150aa-8e6d-496f-8bd1-a57d818b8a7a",
  "createdAt": "2026-01-21T19:49:38.432Z",
  "editorId": "ERKdCGa8risSJqodUxa0Z4Dn",
  "title": "Hello",
  "message": "Hello from the API"
}

Retrieve an editor

Retrieves the basic details of an existing editor.

Arguments:

• editor - The identifier of the editor to be retrieved

Response object:

• An Editor object with the following properties:
• Each entry in the array is an object with the following properties:
  • id - string : The unique identifier of the data source
  • dataSource - object : The Data Source object onto which this editor is connected
    • id - string : The unique identifier of the data source
    • name - string : The name of the data source
    • alias - string : The alias of the data source
  • person - object : The Person object to who created this editor
    • id - string : The unique identifier of the person
    • name - string : The name of the person
    • username - string : The username of the person
    • email - string : The email address of the person
  • createdAt - timestamp : When the editor was created
  • updatedAt - timestamp : When the editor was last updated

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    "${JACKDB_API_URL}/editor/ERV6ThdNrEQt2b0fqAAidrTL"

Example response:

{
  "id": "ERV6ThdNrEQt2b0fqAAidrTL",
  "dataSource": {
    "id": "DUGC6IqGQ4DX00Lt0",
    "name": "General Ledger",
    "alias": "gl-prod"
  },
  "person": {
    "id": "P7ueWXlRjejZU3Yzt",
    "name": "Alexia Buckner",
    "username": "abuckner",
    "email": "alexia.buckner@example.com"
  },
  "createdAt": "2025-03-13T13:57:07.858Z",
  "updatedAt": "2025-03-13T14:27:07.858Z"
}

Retrieve an editor (detailed)

Retrieves the details of an existing editor.

Arguments:

• editor - The identifier of the editor to be retrieved

Response object:

• An Editor object with the following properties:
• Each entry in the array is an object with the following properties:
  • id - string : The unique identifier of the data source
  • dataSource - object : The Data Source object onto which this editor is connected
    • id - string : The unique identifier of the data source
    • name - string : The name of the data source
    • alias - string : The alias of the data source
  • person - object : The Person object to who created this editor
    • id - string : The unique identifier of the person
    • name - string : The name of the person
    • username - string : The username of the person
    • email - string : The email address of the person
  • createdAt - timestamp : When the editor was created
  • updatedAt - timestamp : When the editor was last updated
  • tabs - Array of editor tabs each containing the following fields:
    • id - string : The unique identifier of the editor tab
    • title - string : The title of the editor tab
    • text - string : The text of the editor tab
    • createdAt - timestamp : When the editor tab was created

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    "${JACKDB_API_URL}/editor/ERKdCGa8risSJqodUxa0Z4Dn"

Example response:

{
  "id": "ERKdCGa8risSJqodUxa0Z4Dn",
  "person": {
    "id": "Pjd9pJtjdF3dOcMbn",
    "email": "zayne.tran@example.com",
    "username": "ztran",
    "name": "Zayne Tran"
  },
  "dataSource": {
    "id": "DoNXgceC5Xa7LgrD",
    "alias": null,
    "name": "gl"
  },
  "createdAt": "2025-03-13T20:16:58.197Z",
  "updatedAt": "2025-09-08T12:54:22.443Z",
  "tabs": [
    {
      "id": "85e5c9ec-249a-4d21-be48-5618b2c3eb3c",
      "title": "GL Journals",
      "text": "SELECT * FROM journal_lines",
      "createdAt": "2025-04-13T20:16:58.799Z"
    },
    {
      "id": "93eef8c8-6245-4f81-b334-047bdc63471d",
      "title": "Transaction lookup",
      "text": "SELECT *\nFROM transaction_history WHERE tx_code = 'CX1'",
      "createdAt": "2025-05-10T15:17:32.883Z"
    }
  ]
}