Skip to main content
POST
List Flows

Authorizations

Authorization
string
header
required

OAuth access token issued for the REST resource.

Body

application/json
activeOnly
boolean
default:false

Return only active Flows when true.

cursor
object
includeActivity
boolean
default:true

Include aggregate activity counts. Disable for lightweight selectors and dropdowns.

includeUnscopedCompanies
boolean
default:false

When company filters are supplied, also include authorized Flows with no company.

limit
integer
default:100
Required range: 1 <= x <= 200
selectedCompanies
string[]

Exact Jointl company IDs from companies.list; empty means every authorized company.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
selectedFlowStatus
enum<string>[]

Exact Flow statuses; empty means every authorized status.

Maximum array length: 100
Available options:
ACTIVE,
DRAFT,
ARCHIVED
selectedTags
string[]

Exact Jointl tag IDs; empty means every tag.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
type
enum<string>

Optionally return one exact enabled Flow type.

Available options:
HIRING_REVIEW,
PERFORMANCE,
EXIT_INTELLIGENCE

Response

Operation completed.

data
object
required
requestId
string
required

Request correlation identifier.