Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

The unique identifier of the Upsun project

Pattern: [a-z0-9]+
Example:

"abc123def456"

environmentId
string
required

The environment identifier

Pattern: .+
Example:

"main"

Query Parameters

transaction
string

Filter by transaction name (exact match).

Example:

"App\\Controller\\ProductController::list"

page
integer

Page number for pagination.

Required range: x >= 1
limit
integer

Number of profiles per page.

Required range: 1 <= x <= 100
url
string

Wildcard search across URI, name, and transaction name.

Example:

"/api/products"

is_auto
boolean

When false, excludes auto-triggered (APM) profiles from results.

Example:

false

is_public
enum<string>

Filter to public profiles only when set to "true".

Available options:
true,
false
Example:

"true"

sort_by
enum<string>

Field to sort results by.

Available options:
date,
wt,
io,
cpu,
pmu,
nw,
sql,
http
Example:

"date"

sort_order
enum<string>

Sort direction.

Available options:
asc,
desc
Example:

"desc"

start_date
string<date-time>

Filter profiles created after this date (ISO 8601).

Example:

"2026-01-01T00:00:00+00:00"

end_date
string<date-time>

Filter profiles created before this date (ISO 8601).

Example:

"2026-12-31T23:59:59+00:00"

status_code
enum<integer>

Filter by profile status code: -1=empty, 0=todo, 16=payment_required, 32=too_many_subprofiles, 64=done, 128=failed, 192=rejected.

Available options:
-1,
0,
16,
32,
64,
128,
192
Example:

64

owner
object
languages
object
frameworks
object
items_per_page
integer
Required range: 1 <= x <= 100

Response

Profiles retrieved successfully

_project_id
string
required

Project identifier

Example:

"abc123def456"

_environment_id
string
required

Environment identifier

Example:

"main"

_branch_machine_name
string
required

Branch machine name

Example:

"main-bvxea6i"

_agent
string<uuid>
required

Blackfire Agent UUID

Example:

"a38f69ca-3b56-4ea6-beac-272b2568164a"

profiles
object[]
required

List of profiles

page
integer
required

Current page number

Example:

1

pages
integer
required

Total number of pages

Example:

3

total
integer
required

Total number of profiles

Example:

25

Last modified on June 16, 2026