API Reference
Get Function
API Reference
Get Function
Get information about the given function.
GET
/
v2
/
functions
/
{owner_name}
/
{function_name}
Authorizations
X-API-Key
string
headerrequiredThe Sieve API key to authenticate with.
Path Parameters
owner_name
string
requiredThe owner of the function.
function_name
string
requiredThe name of the function.
Response
200 - application/json
name
string
requiredThe name of the function
owner_name
string
requiredThe owner name of the function
visibility
string
requiredThe visibility of the function
title
string
requiredThe title of the function
code_url
string | null
The link to the code of the function
description
string | null
The description of the function
tags
string[] | null
The tags of the function
cover_image_url
string | null
The url of the function's cover image
examples
string[]
An array of job ids that the function playground will use as an example
readme
string | null
The readme of the function
latest_version
object
requiredThe latest version of the function
featured_key
integer | null
The featured key of the function
function_type
enum<string> | null
The type of the function, either a simple function or a workflow
Available options:
function, workflow webhooks
object[] | null
The webhooks associated with the function
restart_on_error
boolean | null
default: trueWhether to restart the function on job error
Was this page helpful?