List waitpoint tokens

Returns a paginated list of waitpoint tokens for the current environment. Results are ordered by creation date, newest first. Use cursor-based pagination with page[after] and page[before] to navigate pages.

GET /api/v1/waitpoints/tokens

TypeScript

TypeScript

import { wait } from "@trigger.dev/sdk";

// Iterate over all tokens (auto-paginated)
for await (const token of wait.listTokens()) {
  console.log(token.id, token.status);
}

// Filter by status and tags
for await (const token of wait.listTokens({
  status: ["WAITING"],
  tags: ["user:1234567"],
})) {
  console.log(token.id);
}

curl --request GET \
  --url https://api.trigger.dev/api/v1/waitpoints/tokens \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.trigger.dev/api/v1/waitpoints/tokens"

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

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

print(response.text)

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

fetch('https://api.trigger.dev/api/v1/waitpoints/tokens', 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.trigger.dev/api/v1/waitpoints/tokens",
  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.trigger.dev/api/v1/waitpoints/tokens"

	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.trigger.dev/api/v1/waitpoints/tokens")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/waitpoints/tokens")

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": [
    {
      "id": "waitpoint_abc123",
      "url": "https://api.trigger.dev/api/v1/waitpoints/tokens/waitpoint_abc123/callback/abc123hash",
      "tags": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "idempotencyKey": "<string>",
      "idempotencyKeyExpiresAt": "2023-11-07T05:31:56Z",
      "timeoutAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "output": "<string>",
      "outputType": "<string>",
      "outputIsError": true
    }
  ],
  "pagination": {
    "next": "waitpoint_abc123",
    "previous": "waitpoint_xyz789"
  }
}

Authorizations

Authorization · string · header · required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

import { configure } from "@trigger.dev/sdk";

configure({ accessToken: "tr_dev_1234" });

Query Parameters

page[size] · integer

Number of tokens to return per page (1–100).

Required range: 1 <= x <= 100

page[after] · string

Return tokens after this cursor (from pagination.next in a previous response).

page[before] · string

Return tokens before this cursor (from pagination.previous in a previous response).

filter[status] · string

Comma-separated list of statuses to filter by. Allowed values: WAITING, COMPLETED, TIMED_OUT.

filter[idempotencyKey] · string

Filter by idempotency key.

filter[tags] · string

Comma-separated list of tags to filter by.

filter[createdAt][period] · string

Shorthand time period to filter by creation date (e.g. 1h, 24h, 7d). Cannot be combined with filter[createdAt][from] or filter[createdAt][to].

filter[createdAt][from] · string<date-time>

Filter tokens created at or after this ISO 8601 timestamp.

filter[createdAt][to] · string<date-time>

Filter tokens created at or before this ISO 8601 timestamp.

Response

200

application/json

Successful request

data · object[] · required

An array of waitpoint token objects.

Show child attributes

pagination · object · required

Show child attributes