Execute Query

Returns records for a valid SQL query. This endpoint <ul>

  • Can return redacted record values.
  • Supports only the SELECT command.
  • Returns a maximum of 25 records. To return additional records, perform another query using the OFFSET keyword.
  • Can’t modify the vault or perform transactions.
  • Can’t return tokens.
  • Can’t return file download or render URLs.
  • Doesn’t support the WHERE keyword with columns using transient tokenization.
  • Doesn’t support ? conditional for columns with column-level encryption disabled.
  • <ul>

    Path parameters

    vaultIDstringRequired
    ID of the vault.

    Headers

    AuthorizationstringRequired

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

    Request

    This endpoint expects an object.
    querystringOptional

    The SQL query to execute.

    Supported commands:

    • SELECT
    Supported operators:
    • >
    • <
    • =
    • AND
    • OR
    • NOT
    • LIKE
    • ILIKE
    • NULL
    • NOT NULL
    Supported keywords:
    • FROM
    • JOIN
    • INNER JOIN
    • LEFT OUTER JOIN
    • LEFT JOIN
    • RIGHT OUTER JOIN
    • RIGHT JOIN
    • FULL OUTER JOIN
    • FULL JOIN
    • OFFSET
    • LIMIT
    • WHERE
    Supported functions:
    • AVG()
    • SUM()
    • COUNT()
    • MIN()
    • MAX()
    • REDACTION()

    Response

    A successful response.
    recordslist of objects or null
    Records returned by the query.

    Errors