Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orbitsearch.com/llms.txt

Use this file to discover all available pages before exploring further.

Search directories are organization-owned corpora of searchable people assembled from one or more sources. Each directory is isolated within its owning organization — CSV uploads, personal connections, and imported connection lists all feed into the same searchable directory corpus. You manage the full directory lifecycle through the endpoints below, from initial creation through eventual archival or deletion.
Directory search requires an organization API key. Personal API keys cannot search directory corpora. See directory grants for the permission model.

​
Create a directory

POST /v2/organizations/:organizationId/directories Creates a new standard directory inside the specified organization. Use this to set up an isolated searchable corpus before uploading source data.

​
Path parameters

​
organizationId
string
required
The UUID of the organization that will own the directory.

​
Request body

​
name
string
required
A human-readable display name for the directory (for example, "Q4 Prospects").

​
Response fields

​
id
string
UUID that uniquely identifies this directory. Use it in all subsequent source, grant, and search requests.
​
name
string
The display name you provided at creation.
​
type
string
Directory type. One of standard or connections. The Personal Connections directory is connections; all directories you create are standard.
​
org_id
string
UUID of the organization that owns this directory.
curl -X POST "$API_BASE/v2/organizations/$ORGANIZATION_ID/directories" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q4 Prospects"}'

​
List directories

GET /v2/organizations/:organizationId/directories Returns all directories belonging to the specified organization, including any auto-created directories such as Personal Connections.

​
Path parameters

​
organizationId
string
required
The UUID of the organization whose directories you want to list.

​
Response fields

​
directories
object[]
Array of directory objects. Each object contains the same fields as a single directory response: id, name, type, and org_id.
curl "$API_BASE/v2/organizations/$ORGANIZATION_ID/directories" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

​
Get a directory

GET /v2/organizations/:organizationId/directories/:directoryId Returns a single directory by ID.

​
Path parameters

​
organizationId
string
required
The UUID of the owning organization.
​
directoryId
string
required
The UUID of the directory to retrieve.

​
Update a directory

PATCH /v2/organizations/:organizationId/directories/:directoryId Updates mutable fields on a directory, such as its display name.

​
Path parameters

​
organizationId
string
required
The UUID of the owning organization.
​
directoryId
string
required
The UUID of the directory to update.

​
Request body

​
name
string
New display name for the directory.

​
Archive a directory

POST /v2/organizations/:organizationId/directories/:directoryId/archive Archives a directory, immediately preventing new uploads and excluding it from search. Archiving is appropriate when you want to retain the directory record without allowing further writes or queries.

​
Path parameters

​
organizationId
string
required
The UUID of the owning organization.
​
directoryId
string
required
The UUID of the directory to archive.
Archived directories cannot receive new source uploads and cannot be searched. Requests that reference an archived directory in a search scope are rejected with search_directory_not_found.The auto-created Personal Connections directory (type: connections) cannot be archived or deleted.

​
Delete a directory

DELETE /v2/organizations/:organizationId/directories/:directoryId Permanently deletes a directory and all associated data. This action cannot be undone.

​
Path parameters

​
organizationId
string
required
The UUID of the owning organization.
​
directoryId
string
required
The UUID of the directory to delete.
Deletion is permanent. The Personal Connections directory cannot be deleted.