Skip to main content
GET
/
api
/
public
/
v2
/
evaluations
List Evaluations
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/evaluations \
  --header 'X-API-KEY: <x-api-key>'
{
  "success": true,
  "message": "<string>",
  "evaluations": [
    {
      "id": 123,
      "name": "<string>",
      "workspace_id": 123,
      "comment": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "folder_id": 123,
      "user_id": 123
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "pages": 123
}
Retrieve a paginated list of evaluations in your workspace.

​
Authentication

This endpoint requires JWT or API key authentication.

​
Filtering by Name

Use the name parameter to search for evaluations by name. The search is case-insensitive and matches partial names. This is useful for discovering existing evaluations programmatically.

​
Filtering by Status

Use the status parameter to control which evaluations are returned based on their deletion status:
  • active (default): Returns only active evaluations
  • deleted: Returns only deleted/archived evaluations
  • all: Returns both active and deleted evaluations

Headers

​
X-API-KEY
string
required

API key or JWT token for authentication. Use 'X-API-KEY' header for API key or 'Authorization: Bearer' header for JWT.

Query Parameters

​
workspace_id
integer

Filter by specific workspace ID. If not provided, uses the current user's workspace

Required range: x >= 1
​
name
string

Filter evaluations by name (case-insensitive partial match)

​
status
enum<string>
default:active

Filter evaluations by status: 'active' (default) returns only active evaluations, 'deleted' returns only deleted/archived evaluations, 'all' returns both

Available options:
active,
deleted,
all
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
per_page
integer
default:10

Number of items per page

Required range: 1 <= x <= 100

Response

Successful response

​
success
boolean
required
​
message
string
required
​
evaluations
object[]
required
​
page
integer
required
​
per_page
integer
required
​
total
integer
required
​
pages
integer
required