> ## Documentation Index
> Fetch the complete documentation index at: https://docs.floral.so/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/developers/api/authentication) before continuing if you do not have a token.

## Search relationships

<Steps>
  <Step title="Set your credentials">
    ```bash theme={null}
    export FLORAL_TOKEN="floral_pat_..."
    export FLORAL_WORKSPACE="your-workspace"
    export SEARCH_QUERY="Acme"
    export FLORAL_BASE_URL="https://app.floral.so/api/v1"
    ```
  </Step>

  <Step title="Search companies and people">
    ```bash theme={null}
    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.
  </Step>

  <Step title="List recent briefings">
    ```bash theme={null}
    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.
  </Step>
</Steps>

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

## Continue with a task

<CardGroup cols={2}>
  <Card title="Work with companies" icon="building" href="/developers/api/companies">
    List, create, update, archive, and restore companies.
  </Card>

  <Card title="Work with people" icon="users" href="/developers/api/people">
    Synchronize person profiles and company links.
  </Card>

  <Card title="Generate briefings" icon="file-lines" href="/developers/api/briefings">
    Create a briefing safely and poll for completion.
  </Card>

  <Card title="Review summaries" icon="clipboard-check" href="/developers/api/summaries">
    Update summary notes and approve reviewed content.
  </Card>
</CardGroup>
