Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Authenticate with a workspace-pinned Floral personal access token.

Headers

X-Request-ID
string

Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.

Required string length: 1 - 128

Path Parameters

workspaceSlug
string
required

Slug of the workspace pinned to the credential.

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Query Parameters

companyId
integer

Restrict results to people linked to one company ID.

Required range: x >= 1
cursor
string

Opaque cursor returned as nextCursor by the previous page. Do not inspect or construct it.

Maximum string length: 512
lifecycleStage
enum<string>

Restrict results to one lifecycle stage.

Available options:
LEAD,
PROSPECT,
CUSTOMER,
CHURNED
limit
integer
default:20

Number of items to return.

Required range: 1 <= x <= 50
sort
enum<string>
default:updated-desc

Stable collection ordering used by the cursor.

Available options:
updated-desc,
name-asc
status
enum<string>
default:active

Lifecycle state to include in the collection.

Available options:
active,
archived,
all

Response

Successful response

items
object[]
required
Maximum array length: 50
nextCursor
string | null
required
Required string length: 1 - 512