Get a function

Returns a single deployed function. Requires an API key with the environment:functions:read scope.

GET /integrations/{uniqueKey}/functions/{name}

Get a function

cURL

curl --request GET \
  --url https://api.nango.dev/integrations/{uniqueKey}/functions/{name} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.nango.dev/integrations/{uniqueKey}/functions/{name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nango.dev/integrations/{uniqueKey}/functions/{name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/integrations/{uniqueKey}/functions/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/integrations/{uniqueKey}/functions/{name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.nango.dev/integrations/{uniqueKey}/functions/{name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/integrations/{uniqueKey}/functions/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "name": "<string>",
    "type": "sync",
    "returns": [
      "<string>"
    ],
    "json_schema": {},
    "runs": "<string>",
    "auto_start": true,
    "track_deletes": true,
    "id": 123,
    "enabled": true,
    "last_deployed": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "scopes": [
      "<string>"
    ],
    "input": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

Requires an API key with the environment:functions:read scope. Learn more about API key scopes.

Returns a single deployed function.

Authorizations

Authorization · string · header · required

The secret key from your Nango environment.

Path Parameters

uniqueKey · string · required

The integration ID (unique_key) that you created in Nango.

name · string · required

The name of the function.

Query Parameters

type · enum<string>

Disambiguates when multiple functions share the same name.

Available options: sync, action, on-event

Response

200

application/json

Successfully returned the function

data · object · required

A deployed function (sync, action, or on-event) merged with its deployment metadata.

Option 1

Option 2

Option 3

Show child attributes