Quickstart

Authenticate and search relationships in a Floral workspace.

This guide makes two read requests so you can verify authentication, workspace access, pagination, and the public response envelope before adding writes.

Prerequisites

You need:

• a Floral workspace;
• a personal access token with contacts:read and meetings:read;
• the workspace slug from its Floral URL;
• curl installed locally.

See Authentication before continuing if you do not have a token.

Search relationships

1. Set your credentials

   export FLORAL_TOKEN="floral_pat_..."
   export FLORAL_WORKSPACE="your-workspace"
   export SEARCH_QUERY="Acme"
   export FLORAL_BASE_URL="https://app.floral.so/api/v1"
   
2. Search companies and people

   curl --get --fail-with-body \
     --url "$FLORAL_BASE_URL/workspaces/$FLORAL_WORKSPACE/relationships/search" \
     --header "Authorization: Bearer $FLORAL_TOKEN" \
     --header "X-Request-ID: quickstart-relationships-001" \
     --data-urlencode "q=$SEARCH_QUERY" \
     --data-urlencode "limit=8"
   

   Floral returns bounded company and person matches from the selected workspace.

3. List recent briefings

   curl --get --fail-with-body \
     --url "$FLORAL_BASE_URL/workspaces/$FLORAL_WORKSPACE/briefings" \
     --header "Authorization: Bearer $FLORAL_TOKEN" \
     --header "X-Request-ID: quickstart-briefings-001" \
     --data-urlencode "limit=20"
   

   Use the returned nextCursor as the cursor query parameter to fetch another page. A null cursor means there are no more results.

Open the API reference for exact request parameters, response schemas, required scopes, operation identifiers, reliability profiles, and errors.

Continue with a task

Work with companies

List, create, update, archive, and restore companies.

Work with people

Synchronize person profiles and company links.

Generate briefings

Create a briefing safely and poll for completion.

Review summaries

Update summary notes and approve reviewed content.