For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Overview
    • Introduction
    • Response Codes
  • API Reference
      • GETGet filter
      • PUTUpdate filter
      • DELDelete filter
      • GETList filters
      • POSTCreate filters (one per seat)
LogoLogo
API ReferenceFilters

Create filters (one per seat)

||View as Markdown|
POST
https://hublinks.io/rest/accounts/:account_id/campaigns/:campaign_id/filters
POST
/rest/accounts/:account_id/campaigns/:campaign_id/filters
$curl -X POST https://hublinks.io/rest/accounts/account_id/campaigns/campaign_id/filters \
>     -H "X-API-KEY: <apiKey>" \
>     -H "Content-Type: application/json"
200Response
1{
2  "success": true,
3  "filters": [
4    {
5      "type": "filter_LP",
6      "status": "RUN",
7      "filters": {
8        "data_cleansing": true,
9        "include_degree_1": true
10      },
11      "seat_id": "SEAT6a13e661ecc6a86e3fb7",
12      "url_page": "https://www.linkedin.com/search/results/people/?keywords=ceos%20michigan&network=%5B%22S%22%5D&sid=p-e",
13      "filter_id": "filter_4357423a0c38093766fa",
14      "account_id": "ACCO136ce10b5f8a7682efb3",
15      "created_at": 1756556153805,
16      "campaign_id": "campaign_79dc16be15ff633fb8dc",
17      "max_profiles": 500,
18      "filter_group_id": "filter_group_7a935bd04ec72fe08ee9",
19      "profile_fetch_type": "LAZY"
20    }
21  ]
22}
Create multiple filters; generates `filter_group_id`. **Request body fields (wrapped in `campaign` object):** - `name` (string, required) - Human-readable campaign name. - `account_id` (string, required) - Target account ID. - `status` (string, optional) - `DRAFT` | `RUN` | `PAUSE` | `DONE`. Defaults to `DRAFT`. - `seats` (array of strings, required) - Seat IDs to run this campaign. - `schedule` (object, required) - Day-of-week schedule. Each day key maps to `[enabled (bool), start_hour (int), end_hour (int)]`. - `timezone` (integer, optional) - UTC offset in minutes (e.g. `-300` = UTC-5). - `campaign_id` (string, optional) - Supply to create with a specific ID; omit to auto-generate.
Was this page helpful?
Previous

List filters

Next

Get integration

Built with

Create multiple filters; generates filter_group_id.

Request body fields (wrapped in campaign object):

  • name (string, required) - Human-readable campaign name.
  • account_id (string, required) - Target account ID.
  • status (string, optional) - DRAFT | RUN | PAUSE | DONE. Defaults to DRAFT.
  • seats (array of strings, required) - Seat IDs to run this campaign.
  • schedule (object, required) - Day-of-week schedule. Each day key maps to [enabled (bool), start_hour (int), end_hour (int)].
  • timezone (integer, optional) - UTC offset in minutes (e.g. -300 = UTC-5).
  • campaign_id (string, optional) - Supply to create with a specific ID; omit to auto-generate.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

account_idstringRequired
campaign_idstringRequired

Request

This endpoint expects an object.
seatslist of stringsRequired
filterobjectRequired

Response

This endpoint returns an object.
successboolean
filterslist of objects