Servers Playground How we check Add a server Log in

Refine Job Search

Working · 1.8 s

co.getrefine/refinev0.6.0 Domain verified

Job search management: applications, interviews, offers, recruiter email, and company openings.

Productivity

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.getrefine.co/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

account.agenda Read-only

Get upcoming interviews and action items

This tool takes no arguments.

Refine Job Search MCP server | mcptry

Tools (62)

account.agenda

Get upcoming interviews and action items

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

companies.submissions.create

Submit a missing company using its public HTTPS careers URL, supplied or confirmed by the user. Refine detects supported sources and processes openings asynchronously. This adds to the shared index, not to Following. Use companies.submissions.get for progress; follow separately once company.id is available.

Argument	Type	Description
careers_url*	string
company_name*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_name",
    "careers_url"
  ],
  "properties": {
    "careers_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    },
    "company_name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1
    }
  }
}

companies.submissions.get

Read company submission progress. queued/detecting/processing means wait; ready means search again using the company name. unsupported means the careers source is not supported; failed means processing failed. Do not claim the company was added or invent jobs while it is still working.

read-only

Argument	Type	Description
submission_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "submission_id"
  ],
  "properties": {
    "submission_id": {
      "type": "string"
    }
  }
}

following.digest.get

Read the user-wide Following email digest schedule. data is null if no schedule is configured. Company match filters are managed separately with following.update.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

following.digest.update

Set the user-wide Following email digest schedule after the user requests it. Requires Plus or Student. For a new schedule supply frequency, hour (0–23), timezone (IANA), and weekday (Sunday=0) when weekly. Existing schedules can be patched.

Argument	Type	Description
hour	integer
weekday	integer
timezone	string
frequency	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "hour": {
      "type": "integer",
      "maximum": 23,
      "minimum": 0
    },
    "weekday": {
      "type": "integer",
      "maximum": 6,
      "minimum": 0
    },
    "timezone": {
      "type": "string",
      "minLength": 1
    },
    "frequency": {
      "enum": [
        "daily",
        "weekly"
      ],
      "type": "string"
    }
  }
}

following.follow

Follow an indexed company for future matching openings and company recommendations. Get company_id from Search, a ready submission, or a recommendation candidate_company.id. Specify at least one match; [{}] follows all new openings. This does not submit an unknown careers page or collect historical matches.

Argument	Type	Description
filters*	array	Alternative matches (OR). Fields inside each match combine with AND. [{}] follows every new opening. This is the complete filter set, not a patch.
company_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_id",
    "filters"
  ],
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "terms": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 100,
                "minLength": 1
              },
              "maxItems": 40,
              "minItems": 1
            },
            "maxItems": 20,
            "description": "Role keyword groups: alternatives within a group (OR); every group must match (AND). Example: [[\"designer\", \"design\"], [\"senior\"]]."
          },
          "remote": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "true: remote only; false: on-site or hybrid; omitted/null: any workplace."
          },
          "markets": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20,
            "description": "Market slugs, when known. Do not invent slugs."
          },
          "companies": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20,
            "description": "Exact company names or slugs, not company IDs."
          },
          "locations": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 100,
                "minLength": 1
              },
              "maxItems": 40,
              "minItems": 1
            },
            "maxItems": 20,
            "description": "Location alternatives, supplied as groups. Search matches any listed location."
          },
          "seniority": {
            "type": "array",
            "items": {
              "enum": [
                "intern",
                "junior",
                "mid",
                "senior",
                "staff",
                "principal",
                "manager",
                "director",
                "executive"
              ],
              "type": "string"
            },
            "maxItems": 20
          },
          "departments": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20
          },
          "include_unknown": {
            "type": "array",
            "items": {
              "enum": [
                "compensation",
                "seniority",
                "workplace",
                "employment_type",
                "department"
              ],
              "type": "string"
            },
            "maxItems": 5,
            "description": "Also include openings missing these fields when filtering by them."
          },
          "employment_types": {
            "type": "array",
            "items": {
              "enum": [
                "full_time",
                "part_time",
                "contract",
                "internship",
                "temporary"
              ],
              "type": "string"
            },
            "maxItems": 20
          },
          "posted_within_days": {
            "type": "integer",
            "maximum": 3650,
            "exclusiveMinimum": 0
          },
          "compensation_maximum": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Maximum listed annual pay amount, not cents. Omit for no maximum. The index does not convert currencies; check compensation.currency in results.",
            "exclusiveMinimum": 0
          },
          "compensation_minimum": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Minimum listed annual pay amount, not cents. Omit for no minimum. The index does not convert currencies; check compensation.currency in results.",
            "exclusiveMinimum": 0
          }
        }
      },
      "minItems": 1,
      "description": "Alternative matches (OR). Fields inside each match combine with AND. [{}] follows every new opening. This is the complete filter set, not a patch."
    },
    "company_id": {
      "type": "string"
    }
  }
}

following.list

List all followed companies, their filters, state, and unread counts. Returns the full list without pagination. Following delivers future matching openings; use Search to browse jobs already in the index.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

following.openings.list

Read matching openings from followed companies. tab defaults to unread. Use the row id for marking read and nested opening.id for opening details or adding to the board. meta.unread_count/read_count cover the selected follow or all companies before view filters; meta.filtered_count covers the current filtered tab.

read-only

Argument	Type	Description
q	string	Search opening titles.
tab	string
page	string	Pagination cursor returned as meta.next_page
limit	integer	Maximum records to return
location	string	Exact location facet or "remote".
follow_id	string	Follow ID from following.list, not company.id.
department	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "q": {
      "type": "string",
      "description": "Search opening titles."
    },
    "tab": {
      "enum": [
        "unread",
        "read",
        "all"
      ],
      "type": "string",
      "default": "unread"
    },
    "page": {
      "type": "string",
      "description": "Pagination cursor returned as meta.next_page"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Maximum records to return",
      "exclusiveMinimum": 0
    },
    "location": {
      "type": "string",
      "description": "Exact location facet or \"remote\"."
    },
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    },
    "department": {
      "type": "string"
    }
  }
}

following.openings.mark_all_read

Mark all unread openings as read for one follow, or every followed company if follow_id is omitted. Includes every page and openings hidden by view filters. Confirm the scope with the user first. The API returns no affected count; do not invent one.

Argument	Type	Description
confirmed*	boolean
follow_id	string	Follow ID from following.list, not company.id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "confirmed"
  ],
  "properties": {
    "confirmed": {
      "type": "boolean",
      "const": true
    },
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    }
  }
}

following.openings.mark_read

Mark one Following row as read. Use the row id from following.openings.list, not nested opening.id.

Argument	Type	Description
follow_opening_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "follow_opening_id"
  ],
  "properties": {
    "follow_opening_id": {
      "type": "string"
    }
  }
}

following.pause

Pause future matching openings for this follow without deleting it. This does not stop shared company indexing or pause other follows.

Argument	Type	Description
follow_id*	string	Follow ID from following.list, not company.id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "follow_id"
  ],
  "properties": {
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    }
  }
}

following.resume

Resume a paused company follow.

Argument	Type	Description
follow_id*	string	Follow ID from following.list, not company.id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "follow_id"
  ],
  "properties": {
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    }
  }
}

following.unfollow

Unfollow a company and remove its Following feed and recommendation source. Confirm with the user first. Board jobs remain. To pause temporarily instead, use following.pause.

destructive

Argument	Type	Description
confirmed*	boolean
follow_id*	string	Follow ID from following.list, not company.id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "follow_id",
    "confirmed"
  ],
  "properties": {
    "confirmed": {
      "type": "boolean",
      "const": true
    },
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    }
  }
}

following.update

Replace all match filters for a followed company. Other follow settings are unchanged. Pass [{}] for all new openings. Pending means the new filters are being applied; old unread counts may change.

Argument	Type	Description
filters*	array	Alternative matches (OR). Fields inside each match combine with AND. [{}] follows every new opening. This is the complete filter set, not a patch.
follow_id*	string	Follow ID from following.list, not company.id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "follow_id",
    "filters"
  ],
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "terms": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 100,
                "minLength": 1
              },
              "maxItems": 40,
              "minItems": 1
            },
            "maxItems": 20,
            "description": "Role keyword groups: alternatives within a group (OR); every group must match (AND). Example: [[\"designer\", \"design\"], [\"senior\"]]."
          },
          "remote": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "true: remote only; false: on-site or hybrid; omitted/null: any workplace."
          },
          "markets": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20,
            "description": "Market slugs, when known. Do not invent slugs."
          },
          "companies": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20,
            "description": "Exact company names or slugs, not company IDs."
          },
          "locations": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 100,
                "minLength": 1
              },
              "maxItems": 40,
              "minItems": 1
            },
            "maxItems": 20,
            "description": "Location alternatives, supplied as groups. Search matches any listed location."
          },
          "seniority": {
            "type": "array",
            "items": {
              "enum": [
                "intern",
                "junior",
                "mid",
                "senior",
                "staff",
                "principal",
                "manager",
                "director",
                "executive"
              ],
              "type": "string"
            },
            "maxItems": 20
          },
          "departments": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 20
          },
          "include_unknown": {
            "type": "array",
            "items": {
              "enum": [
                "compensation",
                "seniority",
                "workplace",
                "employment_type",
                "department"
              ],
              "type": "string"
            },
            "maxItems": 5,
            "description": "Also include openings missing these fields when filtering by them."
          },
          "employment_types": {
            "type": "array",
            "items": {
              "enum": [
                "full_time",
                "part_time",
                "contract",
                "internship",
                "temporary"
              ],
              "type": "string"
            },
            "maxItems": 20
          },
          "posted_within_days": {
            "type": "integer",
            "maximum": 3650,
            "exclusiveMinimum": 0
          },
          "compensation_maximum": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Maximum listed annual pay amount, not cents. Omit for no maximum. The index does not convert currencies; check compensation.currency in results.",
            "exclusiveMinimum": 0
          },
          "compensation_minimum": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Minimum listed annual pay amount, not cents. Omit for no minimum. The index does not convert currencies; check compensation.currency in results.",
            "exclusiveMinimum": 0
          }
        }
      },
      "minItems": 1,
      "description": "Alternative matches (OR). Fields inside each match combine with AND. [{}] follows every new opening. This is the complete filter set, not a patch."
    },
    "follow_id": {
      "type": "string",
      "description": "Follow ID from following.list, not company.id."
    }
  }
}

inbox.acknowledge

Keep auto-applied inbox items as-is and finalize the automatic action. Confirm the specific items with the user first.

destructive

Argument	Type	Description
ids*	array	Inbox item ids to acknowledge
confirmed*	boolean	Must be true after the user confirms keeping these automatic actions

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids",
    "confirmed"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Inbox item ids to acknowledge"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms keeping these automatic actions"
    }
  }
}

inbox.apply_suggestion

Apply an inbox item's suggested action, such as adding an application to the board or recording a rejection. Confirm the specific action with the user first.

destructive

Argument	Type	Description
item_id*	string	Inbox item id
confirmed*	boolean	Must be true after the user confirms applying this suggestion

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id",
    "confirmed"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms applying this suggestion"
    }
  }
}

inbox.decline

Queue decline replies to recruiter outreach. Depending on the user's preference this SENDS email from their address. Only call after the user explicitly approved declining these specific conversations.

destructive

Argument	Type	Description
ids*	array	Inbox item ids to decline
remember	boolean	Save the preference for future declines
confirmed*	boolean	Must be true, and only after the user explicitly approved declining these conversations
preference	string	Send preference to apply; omit to use the saved preference

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids",
    "confirmed"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Inbox item ids to decline"
    },
    "remember": {
      "type": "boolean",
      "description": "Save the preference for future declines"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true, and only after the user explicitly approved declining these conversations"
    },
    "preference": {
      "enum": [
        "always",
        "review",
        "never"
      ],
      "type": "string",
      "description": "Send preference to apply; omit to use the saved preference"
    }
  }
}

inbox.dismiss

Dismiss inbox items you are not acting on (also marks the mail read in Gmail)

destructive

Argument	Type	Description
ids*	array	Inbox item ids to dismiss
confirmed*	boolean	Must be true after the user confirms dismissing these items and marking their mail read

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ids",
    "confirmed"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "minItems": 1,
      "description": "Inbox item ids to dismiss"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms dismissing these items and marking their mail read"
    }
  }
}

inbox.draft_reply

Generate an AI reply draft for an inbox item. Returns HTML for review; it does not send anything.

read-only

Argument	Type	Description
kind*	string	decline politely passes; interested asks to continue the conversation
item_id*	string	Inbox item id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id",
    "kind"
  ],
  "properties": {
    "kind": {
      "enum": [
        "decline",
        "interested"
      ],
      "type": "string",
      "description": "decline politely passes; interested asks to continue the conversation"
    },
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    }
  }
}

inbox.get

Get one inbox item with its related job and application

read-only

Argument	Type	Description
item_id*	string	Inbox item id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    }
  }
}

inbox.get_thread

Fetch the full email thread for an inbox item

read-only

Argument	Type	Description
item_id*	string	Inbox item id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    }
  }
}

inbox.list

List email conversations Refine matched to your job search (applications, interviews, recruiter outreach)

read-only

Argument	Type	Description
tab	string	Which inbox tab to list; defaults to applications
page	string	Pagination cursor returned as meta.next_page
limit	integer	Maximum records to return
shelf	string	For the outreach tab: show the low-signal shelf instead of the main feed
status	string	pending needs a decision, auto was auto-applied, active has an open conversation, handled is done
unread	boolean	With status=active: only conversations with (or without) an unread reply
account	string	Filter to one connected Google account id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "tab": {
      "enum": [
        "applications",
        "interviews",
        "outreach"
      ],
      "type": "string",
      "description": "Which inbox tab to list; defaults to applications"
    },
    "page": {
      "type": "string",
      "description": "Pagination cursor returned as meta.next_page"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Maximum records to return",
      "exclusiveMinimum": 0
    },
    "shelf": {
      "enum": [
        "low_signal"
      ],
      "type": "string",
      "description": "For the outreach tab: show the low-signal shelf instead of the main feed"
    },
    "status": {
      "enum": [
        "pending",
        "auto",
        "active",
        "handled"
      ],
      "type": "string",
      "description": "pending needs a decision, auto was auto-applied, active has an open conversation, handled is done"
    },
    "unread": {
      "type": "boolean",
      "description": "With status=active: only conversations with (or without) an unread reply"
    },
    "account": {
      "type": "string",
      "description": "Filter to one connected Google account id"
    }
  }
}

inbox.mark_read

Clear an inbox item's unread-reply flag

Argument	Type	Description
item_id*	string	Inbox item id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    }
  }
}

inbox.refresh

Check Gmail for new mail now; returns per-account sync status

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

inbox.send_reply

Send an email reply through the user's Gmail. This emails a real person from the user's address. Only call after the user has seen the exact message body and explicitly approved sending it.

destructive

Argument	Type	Description
body*	string	HTML body of the reply, exactly as approved by the user
item_id*	string	Inbox item id
confirmed*	boolean	Must be true, and only after the user explicitly approved sending this exact message
draft_kind	string	Set when the body came from inbox.draft_reply

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id",
    "body",
    "confirmed"
  ],
  "properties": {
    "body": {
      "type": "string",
      "description": "HTML body of the reply, exactly as approved by the user"
    },
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true, and only after the user explicitly approved sending this exact message"
    },
    "draft_kind": {
      "enum": [
        "decline",
        "interested"
      ],
      "type": "string",
      "description": "Set when the body came from inbox.draft_reply"
    }
  }
}

inbox.sync_status

Per-account Gmail synchronization status, including current progress and last sync time

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

inbox.undo

Undo an auto-applied inbox action. This can delete a board record that the automatic action created, so confirm with the user first.

destructive

Argument	Type	Description
item_id*	string	Inbox item id
confirmed*	boolean	Must be true after the user confirms undoing the automatic action

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id",
    "confirmed"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms undoing the automatic action"
    }
  }
}

inbox.unsubscribe

Unsubscribe the user from this sender's mailing list via one-click list-unsubscribe. This changes the user's real email subscriptions; confirm with them before calling. Use it for unwanted bulk senders, not for a person you can simply decline.

destructive

Argument	Type	Description
item_id*	string	Inbox item id
confirmed*	boolean	Must be true, and only after the user explicitly approved unsubscribing from this sender

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id",
    "confirmed"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "description": "Inbox item id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true, and only after the user explicitly approved unsubscribing from this sender"
    }
  }
}

integrations.connect_google

Get a link for the user to connect Gmail to Refine or approve a missing Gmail permission. Refine selects the permission needed for the connected account. The connection happens in the browser with no Refine sign-in required. Share the link only with the owner of this Refine account.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

integrations.list

List connected Google accounts and their grant status. To connect a new account, use integrations.connect_google.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

jobs.add

Add a new job to your journey

Argument	Type	Description
url	string	URL of the job posting
title*	string	Job title
source	string	Where this job came from
company*	string	Company name
location	string	Job location
description	string	Job description
qualifications	string	Job qualifications
compensation_text	string	Compensation text from the posting

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title",
    "company"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the job posting"
    },
    "title": {
      "type": "string",
      "description": "Job title"
    },
    "source": {
      "type": "string",
      "description": "Where this job came from"
    },
    "company": {
      "type": "string",
      "description": "Company name"
    },
    "location": {
      "type": "string",
      "description": "Job location"
    },
    "description": {
      "type": "string",
      "description": "Job description"
    },
    "qualifications": {
      "type": "string",
      "description": "Job qualifications"
    },
    "compensation_text": {
      "type": "string",
      "description": "Compensation text from the posting"
    }
  }
}

jobs.archive

Hide a job from the active board without recording a rejection or closing the application

Argument	Type	Description
job_id*	string	Job id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    }
  }
}

jobs.delete

Permanently delete a job and its application from the board. Confirm with the user first; it cannot be undone. To hide a job without recording a rejection or closure, use jobs.archive instead.

destructive

Argument	Type	Description
job_id*	string	Job id
confirmed*	boolean	Must be true after the user confirms permanent deletion

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms permanent deletion"
    }
  }
}

jobs.get

Get details of a specific job

read-only

Argument	Type	Description
job_id*	string	Job id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    }
  }
}

jobs.interviews.add

Log an interview for a job

Argument	Type	Description
name*	string	Interview name, e.g. phone screen, technical, behavioral, onsite
notes	string	Notes or debrief from the interview
job_id*	string	Job id
location	string	Location or meeting link
scheduled_at	string	ISO 8601 date/time with timezone

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Interview name, e.g. phone screen, technical, behavioral, onsite"
    },
    "notes": {
      "type": "string",
      "description": "Notes or debrief from the interview"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "location": {
      "type": "string",
      "description": "Location or meeting link"
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 date/time with timezone"
    }
  }
}

jobs.interviews.delete

Permanently delete an interview from a job. Confirm with the user first; it cannot be undone.

destructive

Argument	Type	Description
job_id*	string	Job id
confirmed*	boolean	Must be true after the user confirms permanent deletion
interview_id*	string	Interview id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "interview_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms permanent deletion"
    },
    "interview_id": {
      "type": "string",
      "description": "Interview id"
    }
  }
}

jobs.interviews.update

Update an existing interview

Argument	Type	Description
name	string	Interview name, e.g. phone screen, technical, onsite
notes	string	Notes or debrief from the interview
job_id*	string	Job id
rating	integer	Your rating of the interview, 1 to 5
outcome	string	Interview outcome
feedback	string	Feedback received or given
location	string	Location or meeting link
next_action	string	The next step after this interview
cancelled_at	string	ISO 8601 cancellation time with timezone
completed_at	string	Completion date in YYYY-MM-DD format
interview_id*

jobs.list

List jobs in your journey

read-only

Argument	Type	Description
page	string	Pagination cursor returned as meta.next_page
limit	integer	Maximum records to return

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "string",
      "description": "Pagination cursor returned as meta.next_page"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Maximum records to return",
      "exclusiveMinimum": 0
    }
  }
}

jobs.mark_applied

Mark a job as applied

destructive

Argument	Type	Description
job_id*	string	Job id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    }
  }
}

jobs.offer.accept

Accept the offer for a job. This is a major state change that closes out the search for this role; confirm with the user before calling. It does not email the employer.

destructive

Argument	Type	Description
job_id*	string	Job id
confirmed*	boolean	Must be true after the user confirms accepting the offer

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms accepting the offer"
    }
  }
}

jobs.offer.add_negotiation

Log a negotiation event on an offer (counter-offer, update, etc.)

Argument	Type	Description
notes	string	Notes about this negotiation event
job_id*	string	Job id
event_date	string	Event date in YYYY-MM-DD format
event_type*	string	Whether the event records an employer offer or your counter
bonus_cents	integer	Signing bonus in cents
equity_text	string	Equity details (e.g. "0.05% over 4 years")
salary_cents	integer	Salary in cents (e.g. 15000000 for $150k)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "event_type"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Notes about this negotiation event"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "event_date": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Event date in YYYY-MM-DD format"
    },
    "event_type": {
      "enum": [
        "offer",
        "counter"
      ],
      "type": "string",
      "description": "Whether the event records an employer offer or your counter"
    },
    "bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Signing bonus in cents"
    },
    "equity_text": {
      "type": "string",
      "minLength": 1,
      "description": "Equity details (e.g. \"0.05% over 4 years\")"
    },
    "salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Salary in cents (e.g. 15000000 for $150k)"
    }
  }
}

jobs.offer.create

Record a job offer with compensation details

Argument	Type	Description
notes	string	Notes about the offer
job_id*	string	Job id
currency	string	Supported currency code
rsu_text	string	RSU details as text
bonus_cents	integer	Bonus in cents
deadline_at	string	ISO 8601 offer deadline with timezone
equity_text	string	Equity details as text
next_action	string	The next step on this offer
target_rsu_text	string	The RSUs you are negotiating toward, as text
initial_rsu_text	string	The originally offered RSUs as text
base_salary_cents

jobs.offer.decline

Decline the offer for a job, a major state change; confirm with the user first. It does not email the employer.

destructive

Argument	Type	Description
job_id*	string	Job id
confirmed*	boolean	Must be true after the user confirms declining the offer

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms declining the offer"
    }
  }
}

jobs.offer.delete

Permanently delete the offer recorded for a job (the job stays). Use only to fix a mistake, and confirm with the user first; it cannot be undone.

destructive

Argument	Type	Description
job_id*	string	Job id
confirmed*	boolean	Must be true after the user confirms permanent deletion

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms permanent deletion"
    }
  }
}

jobs.offer.delete_negotiation

Remove a negotiation event from an offer

destructive

Argument	Type	Description
job_id*	string	Job id
event_id*	integer	Negotiation event id
confirmed*	boolean	Must be true after the user confirms deletion

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "event_id",
    "confirmed"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "event_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Negotiation event id",
      "exclusiveMinimum": 0
    },
    "confirmed": {
      "type": "boolean",
      "const": true,
      "description": "Must be true after the user confirms deletion"
    }
  }
}

jobs.offer.update

Update the offer recorded for a job

Argument	Type	Description
notes	string	Notes about the offer
job_id*	string	Job id
currency	string	Supported currency code
rsu_text	string	RSU details as text
bonus_cents	integer	Bonus in cents
deadline_at	string	ISO 8601 offer deadline with timezone
equity_text	string	Equity details as text
next_action	string	The next step on this offer
target_rsu_text	string	The RSUs you are negotiating toward, as text
initial_rsu_text	string	The originally offered RSUs as text
base_salary_cents	integer

jobs.refresh

Queue a job posting to be re-scraped. The returned job may remain pending; use jobs.get later to inspect the refreshed state.

Argument	Type	Description
job_id*	string	Job id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    }
  }
}

jobs.unarchive

Restore an archived job to the active board

Argument	Type	Description
job_id*	string	Job id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job id"
    }
  }
}

jobs.update

Update a job in your journey

Argument	Type	Description
url	string	URL of the job posting
notes	string	Markdown notes about this application
title	string	Job title
job_id*	string	Job id
source	string	Where this job came from
company	string	Company name
location	string	Job location
description	string	Job description
qualifications	string	Job qualifications
compensation_text	string	Compensation text from the posting

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the job posting"
    },
    "notes": {
      "type": "string",
      "description": "Markdown notes about this application"
    },
    "title": {
      "type": "string",
      "description": "Job title"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "source": {
      "type": "string",
      "description": "Where this job came from"
    },
    "company": {
      "type": "string",
      "description": "Company name"
    },
    "location": {
      "type": "string",
      "description": "Job location"
    },
    "description": {
      "type": "string",
      "description": "Job description"
    },
    "qualifications": {
      "type": "string",
      "description": "Job qualifications"
    },
    "compensation_text": {
      "type": "string",
      "description": "Compensation text from the posting"
    }
  }
}

openings.add_to_board

Add an indexed opening to the board after the user chooses it. Uses opening.id, not the Following row ID. Returns the existing board job if already added. This does not apply to the employer or send email; it also marks any matching Following item as read.

Argument	Type	Description
opening_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "opening_id"
  ],
  "properties": {
    "opening_id": {
      "type": "string"
    }
  }
}

openings.get

Read an indexed opening, including its full description and qualifications. Use opening.id from Search or Following, not a follow-opening row ID.

read-only

Argument	Type	Description
opening_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "opening_id"
  ],
  "properties": {
    "opening_id": {
      "type": "string"
    }
  }
}

persona.get

Get the user's persona: inferred job-search preferences and traits with an understanding score. Use it to tailor advice and searches.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

recommendations.block

Dismiss a recommended company and block it from future recommendations

Argument	Type	Description
recommendation_id*	string	Recommendation id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recommendation_id"
  ],
  "properties": {
    "recommendation_id": {
      "type": "string",
      "description": "Recommendation id"
    }
  }
}

recommendations.dismiss

Dismiss a recommended company

Argument	Type	Description
reason	string	Why it was dismissed; sharpens future recommendations
recommendation_id*	string	Recommendation id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recommendation_id"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Why it was dismissed; sharpens future recommendations"
    },
    "recommendation_id": {
      "type": "string",
      "description": "Recommendation id"
    }
  }
}

recommendations.feedback

Record recommendation feedback to improve future suggestions. The historical feedback tag "watched" records that a company was followed; it does not create a follow. Use following.follow first. Dismiss/block/restore actions are separate tools.

Argument	Type	Description
feedback_types*	array	One or more supported feedback tags
recommendation_id*	string	Recommendation id
interaction_source	string	Where the feedback came from in the UI or agent flow

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recommendation_id",
    "feedback_types"
  ],
  "properties": {
    "feedback_types": {
      "type": "array",
      "items": {
        "enum": [
          "watched",
          "dismissed",
          "more_like_this",
          "prefer_startups_growth",
          "prefer_public_companies",
          "too_similar",
          "too_different",
          "wrong_market",
          "wrong_industry",
          "wrong_role_fit",
          "already_know",
          "not_enough_signal",
          "not_interested"
        ],
        "type": "string"
      },
      "minItems": 1,
      "description": "One or more supported feedback tags"
    },
    "recommendation_id": {
      "type": "string",
      "description": "Recommendation id"
    },
    "interaction_source": {
      "type": "string",
      "description": "Where the feedback came from in the UI or agent flow"
    }
  }
}

recommendations.get

Get one recommended company with sources and persona fit

read-only

Argument	Type	Description
recommendation_id*	string	Recommendation id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recommendation_id"
  ],
  "properties": {
    "recommendation_id": {
      "type": "string",
      "description": "Recommendation id"
    }
  }
}

recommendations.list

Discover companies recommended from the companies you follow. Optionally filter by source_company_id (company.id from following.list, not a follow ID). Returns one flat list plus per-source counts. To follow a recommendation, use following.follow with candidate_company.id and your chosen filters.

read-only

Argument	Type	Description
page	string	Pagination cursor returned as meta.next_page
limit	integer	Maximum records to return
source_company_id	string	Company ID of a followed company.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "string",
      "description": "Pagination cursor returned as meta.next_page"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Maximum records to return",
      "exclusiveMinimum": 0
    },
    "source_company_id": {
      "type": "string",
      "description": "Company ID of a followed company."
    }
  }
}

recommendations.restore

Restore a dismissed or blocked recommendation

Argument	Type	Description
recommendation_id*	string	Recommendation id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recommendation_id"
  ],
  "properties": {
    "recommendation_id": {
      "type": "string",
      "description": "Recommendation id"
    }
  }
}

search.company_openings

Read all matching jobs for a company in a ready search, not just its three preview jobs. Continue with data.next_page until null. Use company.id from the search results.

read-only

Argument	Type	Description
page	integer	Numeric results page from results.next_page; not a cursor.
sort	string
search_id*	string
company_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "search_id",
    "company_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Numeric results page from results.next_page; not a cursor.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "enum": [
        "relevance",
        "newest",
        "highest_pay"
      ],
      "type": "string"
    },
    "search_id": {
      "type": "string"
    },
    "company_id": {
      "type": "string"
    }
  }
}

search.create

Search indexed jobs or companies. Supply input OR query, not both. Natural-language searches return a search ID and processing state: use search.get later, without rapid polling. Keep the ID to paginate or update this same search. Empty query {} is All openings, currently sorted by newest without persona personalization.

Argument	Type	Description
page	integer	Numeric results page from results.next_page; not a cursor.
sort	string
view	string
input	string	Natural-language search, processed asynchronously. Omit when supplying query.
query	object	Structured filters. Use {} for All openings; results are immediately available.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Numeric results page from results.next_page; not a cursor.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "enum": [
        "relevance",
        "newest",
        "highest_pay"
      ],
      "type": "string"
    },
    "view": {
      "enum": [
        "jobs",
        "companies"
      ],
      "type": "string"
    },
    "input": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Natural-language search, processed asynchronously. Omit when supplying query."
    },
    "query": {
      "type": "object",
      "properties": {
        "terms": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 40,
            "minItems": 1
          },
          "maxItems": 20,
          "description": "Role keyword groups: alternatives within a group (OR); every group must match (AND). Example: [[\"designer\", \"design\"], [\"senior\"]]."
        },
        "remote": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "true: remote only; false: on-site or hybrid; omitted/null: any workplace."
        },
        "markets": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20,
          "description": "Market slugs, when known. Do not invent slugs."
        },
        "companies": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20,
          "description": "Exact company names or slugs, not company IDs."
        },
        "locations": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 40,
            "minItems": 1
          },
          "maxItems": 20,
          "description": "Location alternatives, supplied as groups. Search matches any listed location."
        },
        "seniority": {
          "type": "array",
          "items": {
            "enum": [
              "intern",
              "junior",
              "mid",
              "senior",
              "staff",
              "principal",
              "manager",
              "director",
              "executive"
            ],
            "type": "string"
          },
          "maxItems": 20
        },
        "departments": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20
        },
        "include_unknown": {
          "type": "array",
          "items": {
            "enum": [
              "compensation",
              "seniority",
              "workplace",
              "employment_type",
              "department"
            ],
            "type": "string"
          },
          "maxItems": 5,
          "description": "Also include openings missing these fields when filtering by them."
        },
        "employment_types": {
          "type": "array",
          "items": {
            "enum": [
              "full_time",
              "part_time",
              "contract",
              "internship",
              "temporary"
            ],
            "type": "string"
          },
          "maxItems": 20
        },
        "posted_within_days": {
          "type": "integer",
          "maximum": 3650,
          "exclusiveMinimum": 0
        },
        "compensation_maximum": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Maximum listed annual pay amount, not cents. Omit for no maximum. The index does not convert currencies; check compensation.currency in results.",
          "exclusiveMinimum": 0
        },
        "compensation_minimum": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Minimum listed annual pay amount, not cents. Omit for no minimum. The index does not convert currencies; check compensation.currency in results.",
          "exclusiveMinimum": 0
        }
      },
      "description": "Structured filters. Use {} for All openings; results are immediately available."
    }
  }
}

search.get

Read a search and its results, switch jobs/companies view, or fetch results.next_page. Pending/interpreting/processing means it is still working: do not create another search or poll rapidly. If missing_company_name is set, ask for its careers URL and use companies.submissions.create. Company rows contain samples, not all matching jobs.

read-only

Argument	Type	Description
page	integer	Numeric results page from results.next_page; not a cursor.
sort	string
view	string
search_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "search_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Numeric results page from results.next_page; not a cursor.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "enum": [
        "relevance",
        "newest",
        "highest_pay"
      ],
      "type": "string"
    },
    "view": {
      "enum": [
        "jobs",
        "companies"
      ],
      "type": "string"
    },
    "search_id": {
      "type": "string"
    }
  }
}

search.update

Update the existing search instead of creating another. Supply input OR the complete replacement query; omitted filters are cleared. Wait until the current search is ready or failed before updating it.

Argument	Type	Description
page	integer	Numeric results page from results.next_page; not a cursor.
sort	string
view	string
input	string	Natural-language search, processed asynchronously. Omit when supplying query.
query	object	Structured filters. Use {} for All openings; results are immediately available.
search_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "search_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Numeric results page from results.next_page; not a cursor.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "enum": [
        "relevance",
        "newest",
        "highest_pay"
      ],
      "type": "string"
    },
    "view": {
      "enum": [
        "jobs",
        "companies"
      ],
      "type": "string"
    },
    "input": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Natural-language search, processed asynchronously. Omit when supplying query."
    },
    "query": {
      "type": "object",
      "properties": {
        "terms": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 40,
            "minItems": 1
          },
          "maxItems": 20,
          "description": "Role keyword groups: alternatives within a group (OR); every group must match (AND). Example: [[\"designer\", \"design\"], [\"senior\"]]."
        },
        "remote": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "true: remote only; false: on-site or hybrid; omitted/null: any workplace."
        },
        "markets": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20,
          "description": "Market slugs, when known. Do not invent slugs."
        },
        "companies": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20,
          "description": "Exact company names or slugs, not company IDs."
        },
        "locations": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "maxItems": 40,
            "minItems": 1
          },
          "maxItems": 20,
          "description": "Location alternatives, supplied as groups. Search matches any listed location."
        },
        "seniority": {
          "type": "array",
          "items": {
            "enum": [
              "intern",
              "junior",
              "mid",
              "senior",
              "staff",
              "principal",
              "manager",
              "director",
              "executive"
            ],
            "type": "string"
          },
          "maxItems": 20
        },
        "departments": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "maxItems": 20
        },
        "include_unknown": {
          "type": "array",
          "items": {
            "enum": [
              "compensation",
              "seniority",
              "workplace",
              "employment_type",
              "department"
            ],
            "type": "string"
          },
          "maxItems": 5,
          "description": "Also include openings missing these fields when filtering by them."
        },
        "employment_types": {
          "type": "array",
          "items": {
            "enum": [
              "full_time",
              "part_time",
              "contract",
              "internship",
              "temporary"
            ],
            "type": "string"
          },
          "maxItems": 20
        },
        "posted_within_days": {
          "type": "integer",
          "maximum": 3650,
          "exclusiveMinimum": 0
        },
        "compensation_maximum": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Maximum listed annual pay amount, not cents. Omit for no maximum. The index does not convert currencies; check compensation.currency in results.",
          "exclusiveMinimum": 0
        },
        "compensation_minimum": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Minimum listed annual pay amount, not cents. Omit for no minimum. The index does not convert currencies; check compensation.currency in results.",
          "exclusiveMinimum": 0
        }
      },
      "description": "Structured filters. Use {} for All openings; results are immediately available."
    },
    "search_id": {
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id",
    "interview_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Interview name, e.g. phone screen, technical, onsite"
    },
    "notes": {
      "type": "string",
      "description": "Notes or debrief from the interview"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "Your rating of the interview, 1 to 5"
    },
    "outcome": {
      "enum": [
        "passed",
        "didnt_pass",
        "pending_decision",
        "withdrew",
        "no_show",
        "other"
      ],
      "type": "string",
      "description": "Interview outcome"
    },
    "feedback": {
      "type": "string",
      "description": "Feedback received or given"
    },
    "location": {
      "type": "string",
      "description": "Location or meeting link"
    },
    "next_action": {
      "type": "string",
      "description": "The next step after this interview"
    },
    "cancelled_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 cancellation time with timezone"
    },
    "completed_at": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Completion date in YYYY-MM-DD format"
    },
    "interview_id": {
      "type": "string",
      "description": "Interview id"
    },
    "interviewers": {
      "type": "string",
      "description": "Names or roles of the interviewers"
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 date/time with timezone"
    },
    "cancelled_reason": {
      "type": "string",
      "description": "Why the interview was cancelled"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Notes about the offer"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "currency": {
      "enum": [
        "USD",
        "EUR",
        "GBP",
        "CAD",
        "AUD"
      ],
      "type": "string",
      "description": "Supported currency code"
    },
    "rsu_text": {
      "type": "string",
      "minLength": 1,
      "description": "RSU details as text"
    },
    "bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Bonus in cents"
    },
    "deadline_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 offer deadline with timezone"
    },
    "equity_text": {
      "type": "string",
      "minLength": 1,
      "description": "Equity details as text"
    },
    "next_action": {
      "type": "string",
      "description": "The next step on this offer"
    },
    "target_rsu_text": {
      "type": "string",
      "description": "The RSUs you are negotiating toward, as text"
    },
    "initial_rsu_text": {
      "type": "string",
      "description": "The originally offered RSUs as text"
    },
    "base_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Base salary in cents (e.g. 15000000 for $150k)"
    },
    "target_bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The bonus you are negotiating toward, in cents"
    },
    "target_equity_text": {
      "type": "string",
      "description": "The equity you are negotiating toward, as text"
    },
    "initial_bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The originally offered bonus in cents"
    },
    "initial_equity_text": {
      "type": "string",
      "description": "The originally offered equity as text"
    },
    "target_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The base salary you are negotiating toward, in cents"
    },
    "initial_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The originally offered base salary in cents"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Notes about the offer"
    },
    "job_id": {
      "type": "string",
      "description": "Job id"
    },
    "currency": {
      "enum": [
        "USD",
        "EUR",
        "GBP",
        "CAD",
        "AUD"
      ],
      "type": "string",
      "description": "Supported currency code"
    },
    "rsu_text": {
      "type": "string",
      "minLength": 1,
      "description": "RSU details as text"
    },
    "bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Bonus in cents"
    },
    "deadline_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "ISO 8601 offer deadline with timezone"
    },
    "equity_text": {
      "type": "string",
      "minLength": 1,
      "description": "Equity details as text"
    },
    "next_action": {
      "type": "string",
      "description": "The next step on this offer"
    },
    "target_rsu_text": {
      "type": "string",
      "description": "The RSUs you are negotiating toward, as text"
    },
    "initial_rsu_text": {
      "type": "string",
      "description": "The originally offered RSUs as text"
    },
    "base_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Base salary in cents (e.g. 15000000 for $150k)"
    },
    "target_bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The bonus you are negotiating toward, in cents"
    },
    "target_equity_text": {
      "type": "string",
      "description": "The equity you are negotiating toward, as text"
    },
    "initial_bonus_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The originally offered bonus in cents"
    },
    "initial_equity_text": {
      "type": "string",
      "description": "The originally offered equity as text"
    },
    "target_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The base salary you are negotiating toward, in cents"
    },
    "initial_salary_cents": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The originally offered base salary in cents"
    }
  }
}