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

q
string
required

Case-insensitive company or person search text.

Required string length: 3 - 200
limit
integer
default:8

Maximum combined matches to return.

Required range: 1 <= x <= 20

Response

Successful response

companies
object[]
required
Maximum array length: 20
people
object[]
required
Maximum array length: 20