Skip to main content
GET
cURL

Autorisationer

Authorization
string
header
påkrævet

Godkend med en personlig Floral-adgangsnøgle, der er bundet til ét arbejdsområde.

Overskrifter

X-Request-ID
string

Valgfrit korrelations-id fra kalderen. Floral returnerer den anvendte værdi i X-Request-ID.

Required string length: 1 - 128

Sti-parametre

workspaceSlug
string
påkrævet

Slug for det arbejdsområde, adgangsoplysningen er bundet til.

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

Forespørgselsparametre

companyId
integer

Begræns resultater til personer med ét bestemt virksomheds-id.

Nødvendigt interval: x >= 1
cursor
string

Uigennemsigtig cursor returneret som nextCursor af den forrige side. Undersøg eller konstruér den ikke.

Maximum string length: 512
lifecycleStage
enum<string>

Begræns resultater til ét trin i livscyklus.

Tilgængelige muligheder:
LEAD,
PROSPECT,
CUSTOMER,
CHURNED
limit
integer
standard:20

Antal elementer, der skal returneres.

Nødvendigt interval: 1 <= x <= 50
sort
enum<string>
standard:updated-desc

Stabil sortering af listen, som cursoren bruger.

Tilgængelige muligheder:
updated-desc,
name-asc
status
enum<string>
standard:active

Livscyklustilstand, der skal medtages i listen.

Tilgængelige muligheder:
active,
archived,
all

Svar

Gennemført svar

items
object[]
påkrævet
Maximum array length: 50
nextCursor
string | null
påkrævet
Required string length: 1 - 512