cURL
Companies
List companies
List a cursor-paginated company collection in one workspace.
GET
cURL
Authorizations
Authenticate with a workspace-pinned Floral personal access token.
Headers
Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.
Required string length:
1 - 128Path Parameters
Slug of the workspace pinned to the credential.
Required string length:
1 - 100Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Query Parameters
Opaque cursor returned as nextCursor by the previous page. Do not inspect or construct it.
Maximum string length:
512Restrict results to one lifecycle stage.
Available options:
LEAD, PROSPECT, CUSTOMER, CHURNED Number of items to return.
Required range:
1 <= x <= 50Stable collection ordering used by the cursor.
Available options:
updated-desc, name-asc Lifecycle state to include in the collection.
Available options:
active, archived, all 