# Orbit Search

> Developer documentation for the Orbit Search API, API keys, directories, credits, and profile search workflows.

## Docs

- [Get your Orbit Search API key](https://docs.orbitsearch.com/api/api-keys/create.md): Get your first Orbit Search API key in the dashboard, choose the right scopes, and store the raw key safely before making API requests.
- [View and audit your Orbit Search API keys](https://docs.orbitsearch.com/api/api-keys/list.md): Use the Orbit developer dashboard to review active and revoked API keys, scopes, last-used timestamps, and expiry status.
- [Revoke or delete an Orbit Search API key](https://docs.orbitsearch.com/api/api-keys/revoke.md): Deactivate an Orbit Search API key from the dashboard when rotating credentials, decommissioning a service, or responding to a suspected exposure.
- [View Orbit Search credits and API usage](https://docs.orbitsearch.com/api/api-keys/usage.md): Track your credit balance, per-key usage, and recent Orbit Search API activity from the developer dashboard and response headers.
- [Directory access grants for Orbit Search directories](https://docs.orbitsearch.com/api/directories/grants.md): Control who can search, upload to, or administer an Orbit directory by assigning grants to organizations, users, or API keys with specific permissions.
- [Manage Search Directories in Orbit via the REST API](https://docs.orbitsearch.com/api/directories/manage.md): Create, retrieve, update, archive, and delete Orbit Search directories. Directories are organization-owned corpora that hold your searchable people data.
- [Upload and manage data sources in an Orbit directory](https://docs.orbitsearch.com/api/directories/sources.md): Upload CSV files to an Orbit Search directory, poll source processing status, check directory readiness, and import personal connections as a searchable source.
- [Directory access for organization API keys](https://docs.orbitsearch.com/api/organizations/directory-access.md): Grant organization API keys access to directories, find directory UUIDs, and run directory-scoped Orbit Search requests.
- [Organization keys and resource ownership](https://docs.orbitsearch.com/api/organizations/overview.md): Understand personal vs. workspace organizations, organization-scoped API keys, and when to use org keys for directory search in Orbit Search.
- [GET /v2/developer/profiles/:id — fetch a profile](https://docs.orbitsearch.com/api/search/profile-read.md): Fetch the public profile DTO for a single Orbit user by ID. Use profile IDs returned from smart search results to retrieve structured profile data.
- [POST /v2/social/profiles/searches/smart — search](https://docs.orbitsearch.com/api/search/smart-search.md): Run a natural language smart search against Orbit's people index. Returns ranked profiles. Supports global and directory scopes. Costs 2 credits per result.
- [Authenticate your requests to the Orbit Search API](https://docs.orbitsearch.com/authentication.md): Orbit Search uses bearer token authentication with scoped API keys. Learn how to get a key, use scopes, rotate keys, and revoke old credentials.
- [How API credits and rate limits work in Orbit Search](https://docs.orbitsearch.com/concepts/credits.md): Orbit Search charges credits per successful request. Learn how reservation, refunds, monthly grants, idempotency, and rate limits work together.
- [Search directories: build a searchable people corpus](https://docs.orbitsearch.com/concepts/directories.md): Directories are private, organization-owned collections of people you can search with the same natural language API as global Orbit Search.
- [Organizations and directory access in Orbit Search](https://docs.orbitsearch.com/concepts/organizations.md): Organizations own your directories, sources, access grants, and API keys. Learn when to use org keys vs. personal keys.
- [How Orbit Search understands and routes your queries](https://docs.orbitsearch.com/concepts/search.md): Learn how Orbit Search interprets natural language, which request fields are required, and how to scope a search to global profiles or private directories.
- [Set up a Search Directory for custom people data](https://docs.orbitsearch.com/guides/directory-setup.md): Create an Orbit Search Directory, upload a CSV of contacts, verify the source is ready, and run a scoped search against your own people data.
- [Handle Orbit Search API errors in your application](https://docs.orbitsearch.com/guides/error-handling.md): Understand the Orbit Search error response format and every error code your application may encounter, including HTTP status, cause, and remediation.
- [Run your first search and read a profile with Orbit](https://docs.orbitsearch.com/guides/first-search.md): Go from zero to receiving profile results with Orbit Search — get an API key, run a smart search, and fetch a full profile record in minutes.
- [Rotate an Orbit Search API key with zero downtime](https://docs.orbitsearch.com/guides/key-rotation.md): Replace an active Orbit Search API key without dropping requests — issue a replacement key, migrate traffic gradually, verify usage, then revoke the old key.
- [What is Orbit Search? People search API overview](https://docs.orbitsearch.com/introduction.md): Orbit Search is a REST API for finding and reading public professional profiles using natural language queries. No search infrastructure to build or maintain.
- [Get started with Orbit Search: your first API call](https://docs.orbitsearch.com/quickstart.md): Get an API key from the Orbit dashboard, run a smart search with a plain-English query, and fetch a full profile record.