Skip to main content
GET
GET /v1/storedProcedures/{id}

Retrieve a Stored Procedure

Get a single stored procedure by its unique ID or fully qualified name.

Get by ID

string
required
UUID of the stored procedure to retrieve.
string
Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,sourceHash).
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/storedProcedures/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the stored procedure (e.g., snowflake_prod.analytics.public.usp_refresh_analytics).
string
Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, sourceHash.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/storedProcedures/{id}

Returns

Returns a stored procedure object with all requested fields populated.

Response

string
Unique identifier for the stored procedure (UUID format).
string
Stored procedure name.
string
Fully qualified name in format service.database.schema.storedProcedure.
string
Human-readable display name.
string
Description of the stored procedure in Markdown format.
object
Reference to the parent database schema.
object
Source code and language. Only included when fields contains storedProcedureCode.
string
Type of database service (e.g., Snowflake, BigQuery, PostgreSQL).
number
Version number for the entity.
array
List of owners. Only included when fields contains owners.
array
Classification tags. Only included when fields contains tags.
array
Domain assignments. Only included when fields contains domains.

Error Handling