Skip to main content
GET
/
functions
/
dryruns
/
{id}
Get dry run results
curl --request GET \
  --url https://api.nango.dev/functions/dryruns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 1,
  "output": "<string>",
  "result": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "payload": "<unknown>"
  }
}
Requires an API key with the environment:functions:dryrun scope. Learn more about API key scopes.
Returns the status and result of an asynchronous function dry run.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Path Parameters

​
id
string<uuid>
required

Response

Successfully retrieved the dry run.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
waiting,
running,
success,
failed
​
integration_id
string
required
​
function_type
enum<string>
required
Available options:
action,
sync
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
started_at
string<date-time>
​
completed_at
string<date-time>
​
duration_ms
integer
Required range: x >= 0
​
output
string

Dry run command output.

​
result
any

The function result, when the dry run emits one.

​
error
object