# Highperformr API

## Docs
- [Introduction](https://docs.highperformr.ai/introduction-2091571m0.md): 

## API Docs
- Contacts [Bulk fetch contacts by IDs](https://docs.highperformr.ai/bulk-fetch-contacts-by-ids-33411478e0.md): Load up to **100** contacts by their **contact `id`** (the same `id` returned in contact records and list APIs). Send at least one ID in `contactIds`. The API returns **400** if you send more than 100 IDs.
- Contacts [Get contacts by segment](https://docs.highperformr.ai/get-contacts-by-segment-33377302e0.md): Returns contacts that belong to the given segment. Optionally add `conditions` to narrow results further; condition rules are the same as **POST /contacts/filter-contacts**.
- Contacts [Get contact by ID](https://docs.highperformr.ai/get-contact-by-id-33411479e0.md): Returns **one contact** by its stable **`id`** (same id as in lists and search results).
- Contacts [Update contact](https://docs.highperformr.ai/update-contact-33411480e0.md): Applies a **partial update** to an existing contact. Only fields present in the body are changed; omitted fields are left as-is.
- Contacts [Delete contact](https://docs.highperformr.ai/delete-contact-33411481e0.md): Marks the contact as **deleted** in this workspace (typically a soft delete via status); the record is no longer returned in normal lists. Downstream sync and compliance behavior follow product rules for linked sources.
- Contacts [Upsert contact into a source](https://docs.highperformr.ai/upsert-contact-into-a-source-33411482e0.md): **Creates or updates** a contact **scoped to a data source** (import, integration, or webhook source).
- Contacts [Bulk upsert contacts for source](https://docs.highperformr.ai/bulk-upsert-contacts-for-source-33411483e0.md): Accepts a **batch of contact rows** and upserts them into the given **source** (integrations, migrations, or custom loaders).
- Contacts [Unique values of one field for a filtered contact set](https://docs.highperformr.ai/unique-values-of-one-field-for-a-filtered-contact-set-33411484e0.md): Given optional contact **conditions** and a **`groupByField`** (a field path from **GET /schema/contact**), returns the **distinct values** that appear on matching contacts for that field.
- Contacts [Unified Data API - async contact enrichment](https://docs.highperformr.ai/unified-data-api-async-contact-enrichment-33377303e0.md): Runs **asynchronous contact enrichment**: the API accepts the request, returns **202** with a **`jobStatusEndpoint`**, and processes enrichment in the background.
- Schema [Get contact schema](https://docs.highperformr.ai/get-contact-schema-33377304e0.md): Returns the field definitions for contacts (and related company fields) in this workspace. Each item includes a **`writeAccessPath`**—use that exact string when:
- Schema [Get discovery search contact schema](https://docs.highperformr.ai/get-discovery-search-contact-schema-33377305e0.md): Field catalog for **contact discovery** filters (prospecting). Paths use **`hpContact.*`** and **`hpCompany.*`** prefixes (for example `hpContact.member_job_title`, `hpCompany.industry`)—use the **`writeAccessPath`** from this response in **`groupedCondition`** on **POST /discovery-search/find-contacts-v2**.
- Schema [Get discovery search company schema](https://docs.highperformr.ai/get-discovery-search-company-schema-33377306e0.md): Field catalog for **company discovery** filters. Paths use **`hpCompany.*`** (and **`hpContact.*`** where person attributes apply). Use **`writeAccessPath`** values from this response in **POST /discovery-search/find-companies-v2**.
- Schema [Get options for field](https://docs.highperformr.ai/get-options-for-field-33377307e0.md): Allowed **enum / picklist** values for a **contact** field (e.g. dropdown custom fields).
- Schema [Get discovery search options for field](https://docs.highperformr.ai/get-discovery-search-options-for-field-33377308e0.md): Allowed values for a **discovery** filter field (autocomplete backing).
- Discovery search [Find contacts v2](https://docs.highperformr.ai/find-contacts-v2-33377309e0.md): **Prospecting search** for people matching **`groupedCondition`** and/or root **`conditions`**, plus **`fields`** and optional **`limit`** / **`paginationToken`**.
- Discovery search [Find companies v2](https://docs.highperformr.ai/find-companies-v2-33377310e0.md): **Company discovery** with the same pipeline as find-contacts-v2: **`groupedCondition`** and/or **`conditions`**, **`fields`**, **`limit`**, **`paginationToken`**.
- Jobs [Get job status by id](https://docs.highperformr.ai/get-job-status-by-id-33411485e0.md): Returns the latest **status, progress, and result payload** for the job. Use the id you received when the async job was created.
- Social publishing [Create draft post](https://docs.highperformr.ai/create-draft-post-33411486e0.md): Creates a **draft** post for a provider. **`providerId`** — use **`POST /api/integrations/filter-integrations`** to obtain integration **`id`** values. Optional **`media`** entries reference **`fileName`** values from `/media/upload` or `/media/upload-url`.
- Social publishing [List posts (drafts, scheduled, published)](https://docs.highperformr.ai/list-posts-drafts-scheduled-published-33411487e0.md): **Filter and list posts** using structured **conditions** (field, operator, value), e.g. `status == draft`, `providerId in [...]`, pagination, and sorting. Commonly used to list drafts before scheduling.
- Social publishing [Schedule or publish posts (bulk)](https://docs.highperformr.ai/schedule-or-publish-posts-bulk-33411488e0.md): For each entry, schedules **one** publish per `schedules[]` row: **`postId`**, **`providerId`**, **`scheduledTime`** (ISO-8601), optional **`automation`** (e.g. Twitter thread delay).
- Social publishing [Schedule a LinkedIn comment on an external post](https://docs.highperformr.ai/schedule-a-linkedin-comment-on-an-external-post-33411489e0.md): Creates a draft scoped as an **external reply** (`externalPost: true`) and **schedules** it via the same pipeline as normal posts.
- Social publishing [Configure cross-account auto-repost](https://docs.highperformr.ai/configure-cross-account-auto-repost-33411490e0.md): Updates **`automation.crossAccountRepostConfig`** on the **parent** post: `enabled` and `providersConfig` derived from `reposts`.
- Social publishing [Upload media file (multipart)](https://docs.highperformr.ai/upload-media-file-multipart-33411491e0.md): Multipart upload of a single **`file`** part. Returns **`fileName`** (storage path) and a short-lived **`readUrl`** (signed URL). **Persist `fileName`** in `POST/PATCH /posts` `media[]`.
- Social publishing [Assemble chunked uploads into one file](https://docs.highperformr.ai/assemble-chunked-uploads-into-one-file-33411492e0.md): After uploading each chunk with `/media/upload`, call this with ordered **`chunks`** (`fileName`, `chunkNumber`) and **`fileExtension`** to produce a single **`fileName`** + **`readUrl`** for use in posts (typically video).
- Social publishing [Import media from a public URL](https://docs.highperformr.ai/import-media-from-a-public-url-33411493e0.md): Downloads **`url`** to workspace storage; returns **`fileName`**, **`contentType`**, **`readUrl`**. Use **`fileName`** in post `media` / `articles` like a normal upload.
- Integrations (social) [List social integrations (filter)](https://docs.highperformr.ai/list-social-integrations-filter-33411494e0.md): Returns **connected Twitter and LinkedIn providers** for the workspace, with pagination.