Refine Job Search MCP

account.agenda

Get upcoming interviews and action items

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['range', 'scheduled', 'needs_attention'], 'properties': {'range': {'enum': ['today', 'week'], 'type': 'string', 'description': 'Covered agenda range'}, 'timezone': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'User timezone'}, 'scheduled': {'type': 'object', 'required': ['total_count', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'job': {'anyOf': [{'type': 'object', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'due_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'actions': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'ends_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'priority': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subtitle': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'starts_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'has_more': {'type': 'boolean'}, 'total_count': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0}}, 'additionalProperties': {}}, 'generated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Briefing generation time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'error': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'last_synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Calendar synchronization status'}, 'needs_attention': {'type': 'object', 'required': ['total_count', 'items'], 'properties': {'items': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'job': {'anyOf': [{'type': 'object', 'properties': {'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'due_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'actions': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'ends_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'priority': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subtitle': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'starts_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'has_more': {'type': 'boolean'}, 'total_count': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0}}, 'additionalProperties': {}}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.acknowledge

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

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['acknowledged'], 'properties': {'acknowledged': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'Number of inbox items acknowledged'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conversation classification'}, 'email': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'snippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'replyable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'thread_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'dkim_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'unsubscribable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Email summary and sender details'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Inbox workflow state'}, 'payload': {'anyOf': [{'type': 'object', 'properties': {'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recruiter_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'created_board_record': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Extracted job-search details'}, 'related': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Related conversations'}, 'replied': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Refine has replied'}, 'resulting': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Board record created or changed by the action'}, 'confidence': {'anyOf': [{'enum': ['high', 'low'], 'type': 'string'}, {'type': 'null'}], 'description': 'Classification confidence'}, 'unread_reply': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether the conversation has an unread reply'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり外部アクセスあり

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['queued'], 'properties': {'queued': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'Number of decline replies queued'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.dismiss

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

破壊的操作あり外部アクセスあり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['dismissed'], 'properties': {'dismissed': {'type': 'integer', 'maximum': 9007199254740991, 'minimum': 0, 'description': 'Number of inbox items dismissed'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.draft_reply

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

読み取り専用冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['kind', 'body'], 'properties': {'body': {'type': 'string', 'description': 'Generated HTML email body'}, 'kind': {'type': 'string', 'description': 'Draft type'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.get

Get one inbox item with its related job and application

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conversation classification'}, 'email': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'snippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'replyable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'thread_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'dkim_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'unsubscribable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Email summary and sender details'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Inbox workflow state'}, 'payload': {'anyOf': [{'type': 'object', 'properties': {'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recruiter_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'created_board_record': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Extracted job-search details'}, 'related': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Related conversations'}, 'replied': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Refine has replied'}, 'resulting': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Board record created or changed by the action'}, 'confidence': {'anyOf': [{'enum': ['high', 'low'], 'type': 'string'}, {'type': 'null'}], 'description': 'Classification confidence'}, 'unread_reply': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether the conversation has an unread reply'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.get_thread

Fetch the full email thread for an inbox item

読み取り専用外部アクセスあり冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Message body'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Sender, or me for the connected user'}, 'preview': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short message preview'}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the message was sent'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.list

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

読み取り専用冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conversation classification'}, 'email': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'snippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'replyable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'thread_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'dkim_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'unsubscribable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Email summary and sender details'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Inbox workflow state'}, 'payload': {'anyOf': [{'type': 'object', 'properties': {'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recruiter_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'created_board_record': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Extracted job-search details'}, 'related': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Related conversations'}, 'replied': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Refine has replied'}, 'resulting': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Board record created or changed by the action'}, 'confidence': {'anyOf': [{'enum': ['high', 'low'], 'type': 'string'}, {'type': 'null'}], 'description': 'Classification confidence'}, 'unread_reply': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether the conversation has an unread reply'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.mark_read

Clear an inbox item's unread-reply flag

冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

inbox.refresh

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

外部アクセスあり

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connected Google account email'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connection status'}, 'mailbox': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Mailbox synchronization state'}, 'syncing': {'anyOf': [{'type': 'object', 'properties': {'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages_seen': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'messages_processed': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Current mailbox synchronization progress'}, 'last_synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the mailbox last finished synchronizing'}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Mailbox synchronization status'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this is the primary account'}}, 'additionalProperties': False}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり外部アクセスあり

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conversation classification'}, 'email': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'snippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'replyable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'thread_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'dkim_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'unsubscribable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Email summary and sender details'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Inbox workflow state'}, 'payload': {'anyOf': [{'type': 'object', 'properties': {'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recruiter_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'created_board_record': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Extracted job-search details'}, 'related': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Related conversations'}, 'replied': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Refine has replied'}, 'resulting': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Board record created or changed by the action'}, 'confidence': {'anyOf': [{'enum': ['high', 'low'], 'type': 'string'}, {'type': 'null'}], 'description': 'Classification confidence'}, 'unread_reply': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether the conversation has an unread reply'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

inbox.sync_status

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

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connected Google account email'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connection status'}, 'mailbox': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Mailbox synchronization state'}, 'syncing': {'anyOf': [{'type': 'object', 'properties': {'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages_seen': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'messages_processed': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Current mailbox synchronization progress'}, 'last_synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the mailbox last finished synchronizing'}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Mailbox synchronization status'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this is the primary account'}}, 'additionalProperties': False}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Conversation classification'}, 'email': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'snippet': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'replyable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'thread_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'dkim_verified': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'unsubscribable': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Email summary and sender details'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Inbox workflow state'}, 'payload': {'anyOf': [{'type': 'object', 'properties': {'role': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recruiter_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'created_board_record': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Extracted job-search details'}, 'related': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'description': 'Related conversations'}, 'replied': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Refine has replied'}, 'resulting': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'job_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Board record created or changed by the action'}, 'confidence': {'anyOf': [{'enum': ['high', 'low'], 'type': 'string'}, {'type': 'null'}], 'description': 'Classification confidence'}, 'unread_reply': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether the conversation has an unread reply'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり外部アクセスあり

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

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.

外部アクセスあり

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['connect_url', 'instructions'], 'properties': {'expires_at': {'type': 'string', 'description': 'When the connection URL expires'}, 'connect_url': {'type': 'string', 'format': 'uri', 'description': 'Single-use browser URL for connecting Gmail'}, 'instructions': {'type': 'string', 'description': 'Safety and usage instructions for the connection URL'}}, 'additionalProperties': False}

integrations.list

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

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'email': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connected Google account email'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Connection status'}, 'mailbox': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Mailbox synchronization state'}, 'syncing': {'anyOf': [{'type': 'object', 'properties': {'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages_seen': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'messages_processed': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Current mailbox synchronization progress'}, 'last_synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the mailbox last finished synchronizing'}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Mailbox synchronization status'}, 'primary': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this is the primary account'}, 'gmail_granted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Gmail read access is granted'}, 'calendar_granted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Calendar read access is granted'}, 'gmail_send_granted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Gmail send access is granted'}, 'calendar_write_granted': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether Calendar write access is granted'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.add

Add a new job to your journey

外部アクセスあり

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.archive

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

冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

jobs.get

Get details of a specific job

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.interviews.add

Log an interview for a job

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.interviews.delete

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

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

jobs.interviews.update

Update an existing interview

冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.list

List jobs in your journey

読み取り専用冪等

入力スキーマ

{'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}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.mark_applied

Mark a job as applied

破壊的操作あり冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.offer.add_negotiation

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

入力スキーマ

{'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)'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.offer.create

Record a job offer with compensation details

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.offer.decline

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

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

jobs.offer.delete_negotiation

Remove a negotiation event from an offer

破壊的操作あり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

jobs.offer.update

Update the offer recorded for a job

冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

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.

外部アクセスあり

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.unarchive

Restore an archived job to the active board

冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

jobs.update

Update a job in your journey

外部アクセスあり冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

persona.get

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

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id', 'traits'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'traits': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'facet': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Preference category'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the trait was learned'}, 'polarity': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Preference or dealbreaker'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Inference confidence'}, 'value_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Text value'}, 'confirmed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Confirmation time'}, 'value_number': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Numeric value'}}, 'additionalProperties': {}}, 'description': 'Known job-search preferences and dealbreakers'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Last computation time'}, 'facet_scores': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {'type': 'number'}}, 'missing_facets': {'type': 'array', 'items': {'type': 'string'}}, 'understanding_score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'How complete the persona is'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.list

List companies you are tracking

読み取り専用冪等

入力スキーマ

{'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}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.list_applied_jobs

List jobs in your journey that came from a tracked company

読み取り専用冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id'], 'properties': {'page': {'type': 'string', 'description': 'Pagination cursor returned as meta.next_page'}, 'limit': {'type': 'integer', 'maximum': 100, 'description': 'Maximum records to return', 'exclusiveMinimum': 0}, 'signal_id': {'type': 'string', 'description': 'Signal (tracked company) id'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.openings.list

List signal notifications (new openings at tracked companies)

読み取り専用冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'properties': {'q': {'type': 'string', 'description': 'Free-text search over opening titles'}, 'tab': {'enum': ['all', 'new'], 'type': 'string', 'description': 'Use new for unread notifications'}, 'page': {'type': 'string', 'description': 'Pagination cursor returned as meta.next_page'}, 'limit': {'type': 'integer', 'maximum': 100, 'description': 'Maximum records to return', 'exclusiveMinimum': 0}, 'matches': {'type': 'boolean', 'description': 'Only openings that score as a match for your persona'}, 'location': {'type': 'string', 'description': 'Exact location facet; use "remote" for remote roles'}, 'department': {'type': 'string', 'description': 'Exact department facet'}, 'tracker_id': {'type': 'string', 'description': 'Filter notifications to one signal tracker'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'channel': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Delivery channel'}, 'opening': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'team': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'remote': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'posted_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'department': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'last_seen_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'employment_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Matched company opening', 'additionalProperties': {}}, 'read_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Read time'}, 'tracker': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}, 'event_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Notification event type'}, 'delivered_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Delivery time'}}, 'additionalProperties': {}}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.openings.mark_all_read

Mark every unread opening notification as read after the user confirms the bulk action

冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['confirmed'], 'properties': {'confirmed': {'type': 'boolean', 'const': True, 'description': 'Must be true after the user confirms marking all openings read'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

signals.openings.mark_read

Mark one opening notification returned by signals.openings.list as read

冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['notification_id'], 'properties': {'notification_id': {'type': 'string', 'description': 'Notification id from signals.openings.list'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

signals.openings.save

Save a matched opening returned by signals.openings.list to your job journey

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['opening_id'], 'properties': {'opening_id': {'type': 'string', 'description': 'Matched opening id from signals.openings.list'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job posting URL'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current job processing state'}, 'title': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job title'}, 'source': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Where the job came from'}, 'company': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job location'}, 'logo_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company logo URL'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was created'}, 'removed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was removed'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was updated'}, 'captured_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the job was captured'}, 'company_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company website URL'}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job description'}, 'refreshed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the posting was last refreshed'}, 'scrape_engine': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scraper used for the posting'}, 'qualifications': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Job qualifications'}, 'job_application': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'offer': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer state'}, 'currency': {'anyOf': [{'enum': ['USD', 'EUR', 'GBP', 'CAD', 'AUD'], 'type': 'string'}, {'type': 'null'}], 'description': 'Supported currency code'}, 'rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'RSU details'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus in cents'}, 'deadline_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Offer deadline'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next offer action'}, 'target_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target RSUs'}, 'initial_rsu_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered RSUs'}, 'base_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Base salary in cents'}, 'negotiation_events': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation notes'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the event was recorded'}, 'event_date': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Negotiation event date'}, 'event_type': {'anyOf': [{'enum': ['offer', 'counter'], 'type': 'string'}, {'type': 'null'}], 'description': 'Negotiation event type'}, 'bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Bonus amount in cents'}, 'equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Equity details'}, 'salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Salary amount in cents'}}, 'additionalProperties': {}}, 'description': 'Negotiation history'}, 'target_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target bonus in cents'}, 'target_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Target equity'}, 'initial_bonus_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered bonus in cents'}, 'initial_equity_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Originally offered equity'}, 'target_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Target salary in cents'}, 'initial_salary_cents': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Originally offered salary in cents'}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Application state'}, 'outcome': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'closed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'applied_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'interviews': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'conversations': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'from': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'kind': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'unread': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}]}, 'sent_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'subject': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'messages': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}}, 'current_phase': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Current application phase'}, 'current_stage': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'last_action_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'recent_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'interviews_summary': {'anyOf': [{'type': 'object', 'properties': {'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'upcoming_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'completed_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}, 'upcoming_interview': {'anyOf': [{'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview name'}, 'notes': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview notes'}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interview state'}, 'rating': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'User rating from 1 to 5'}, 'outcome': {'anyOf': [{'enum': ['passed', 'didnt_pass', 'pending_decision', 'withdrew', 'no_show', 'other'], 'type': 'string'}, {'type': 'null'}], 'description': 'Interview outcome'}, 'feedback': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Feedback received or given'}, 'location': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Location or meeting link'}, 'sequence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Interview order within the process'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'next_action': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Next interview action'}, 'cancelled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cancellation date and time'}, 'completed_at': {'anyOf': [{'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])))$'}, {'type': 'null'}], 'description': 'Completion date in YYYY-MM-DD format'}, 'interviewers': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Interviewers'}, 'scheduled_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Scheduled date and time'}, 'calendar_sync': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'state': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'synced_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'matched_by': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'account_email': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'from_calendar': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'description': 'Whether this came from a connected calendar'}, 'cancelled_reason': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Why the interview was cancelled'}, 'location_details': {'anyOf': [{'type': 'object', 'properties': {'url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Clickable meeting URL'}, 'type': {'anyOf': [{'enum': ['coderpad', 'hackerrank', 'codesignal', 'karat', 'hirevue', 'woven', 'filtered', 'byteboard', 'zoom', 'google-meet', 'microsoft-teams', 'webex', 'gotomeeting', 'whereby', 'around', 'chime', 'bluejeans', 'dialpad', 'ringcentral', 'discord', 'phone', 'physical'], 'type': 'string'}, {'type': 'null'}], 'description': 'Detected meeting provider, phone, or physical location'}, 'display_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Human-readable location or meeting provider'}}, 'additionalProperties': False}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}]}}, 'additionalProperties': {}}, {'type': 'null'}], 'description': 'Application lifecycle, interviews, offer, and conversations'}, 'compensation_text': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Compensation as written in the posting'}}, 'additionalProperties': {}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.pause

Pause tracking for a company

冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id'], 'properties': {'signal_id': {'type': 'string', 'description': 'Signal (tracked company) id'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.block

Dismiss a recommended company and block it from future recommendations

冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.dismiss

Dismiss a recommended company

冪等

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.feedback

Record why a recommendation was or was not a fit; this sharpens future recommendations and the persona

入力スキーマ

{'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'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.get

Get one recommended company with sources and persona fit

読み取り専用冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.list

List companies recommended from one company you track. Get signal_id from signals.list.

読み取り専用冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id'], 'properties': {'page': {'type': 'string', 'description': 'Pagination cursor returned as meta.next_page'}, 'limit': {'type': 'integer', 'maximum': 100, 'description': 'Maximum records to return', 'exclusiveMinimum': 0}, 'signal_id': {'type': 'string', 'description': 'Tracked-company id from signals.list'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.restore

Restore a dismissed or blocked recommendation

冪等

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.recommendations.watch

Start tracking a recommended company (converts it into a signal)

外部アクセスあり

入力スキーマ

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

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'fit': {'anyOf': [{'type': 'object', 'properties': {'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reasons': {'type': 'array', 'items': {'type': 'object', 'properties': {'note': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'weight': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'trait_id': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'direction': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}}}, 'additionalProperties': False}, {'type': 'null'}], 'description': 'Persona fit score and reasons'}, 'tags': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'score': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation score'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Recommendation status'}, 'sources': {'type': 'array', 'items': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, 'reason_rank': {'anyOf': [{'type': 'number'}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}}, 'additionalProperties': False}, 'description': 'Recommendation sources'}, 'confidence': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Recommendation confidence'}, 'created_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was created'}, 'updated_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was last updated'}, 'computed_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'When the recommendation was computed'}, 'reason_body': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Detailed explanation'}, 'reason_headline': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Short explanation'}, 'blocking_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'reason_fragments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'candidate_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Recommended company', 'additionalProperties': False}, 'supporting_factors': {'anyOf': [{'type': 'array', 'items': {'type': 'object', 'propertyNames': {'type': 'string'}, 'additionalProperties': {}}}, {'type': 'null'}]}, 'recommendation_mode': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How the recommendation was generated'}, 'matching_roles_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Number of matching roles'}, 'matching_role_families': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'primary_source_company': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'market': {'anyOf': [{'type': 'object', 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'name': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'slug': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'additionalProperties': False}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'website_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'company_size': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'ownership_type': {'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'description': 'Tracked company that led to this recommendation', 'additionalProperties': False}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.resume

Resume tracking for a company

冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id'], 'properties': {'signal_id': {'type': 'string', 'description': 'Signal (tracked company) id'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.track

Start tracking a company for new job openings

外部アクセスあり

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['company_name', 'careers_url'], 'properties': {'locations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Locations to filter by; use "remote" for remote roles'}, 'careers_url': {'type': 'string', 'format': 'uri', 'description': 'URL of the company careers page'}, 'departments': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Departments to filter by'}, 'company_name': {'type': 'string', 'description': 'Name of the company'}, 'sync_frequency': {'enum': ['weekly', 'daily'], 'type': 'string', 'description': 'How often Refine should refresh this company'}, 'exclude_keywords': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords to exclude'}, 'include_keywords': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords that must appear in the role'}, 'seniority_levels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Seniority levels to include'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

signals.untrack

Stop tracking a company and delete its signal. Confirm with the user first; they stop getting new openings from it. To stop notifications temporarily instead, use signals.pause.

破壊的操作あり冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id', 'confirmed'], 'properties': {'confirmed': {'type': 'boolean', 'const': True, 'description': 'Must be true after the user confirms they want to stop tracking the company'}, 'signal_id': {'type': 'string', 'description': 'Signal (tracked company) id'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['message'], 'properties': {'message': {'type': 'string', 'description': 'Human-readable confirmation of the action'}}, 'additionalProperties': False}

signals.update

Update filters on a tracked company

冪等

入力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['signal_id'], 'properties': {'locations': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Locations to filter by; use "remote" for remote roles'}, 'signal_id': {'type': 'string', 'description': 'Signal (tracked company) id'}, 'departments': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Departments to filter by'}, 'sync_frequency': {'enum': ['weekly', 'daily'], 'type': 'string', 'description': 'How often Refine should refresh this company'}, 'exclude_keywords': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords to exclude'}, 'include_keywords': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Keywords that must appear in the role'}, 'seniority_levels': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Seniority levels to include'}}}

出力スキーマ

{'type': 'object', '$schema': 'https://json-schema.org/draft/2020-12/schema', 'required': ['data'], 'properties': {'data': {'type': 'object', 'required': ['id'], 'properties': {'id': {'anyOf': [{'type': 'string'}, {'type': 'number'}], 'description': 'Stable resource identifier'}, 'status': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Tracking status'}, 'locations': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'careers_url': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company careers URL'}, 'departments': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'company_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company name'}, 'display_name': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Company display name'}, 'sync_frequency': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'How often the company is refreshed'}, 'exclude_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'include_keywords': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'seniority_levels': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}]}, 'notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total notifications'}, 'unread_notifications_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Unread notifications'}}, 'additionalProperties': False}, 'meta': {'type': 'object', 'properties': {'next_page': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'description': 'Cursor for the next page'}, 'total_count': {'anyOf': [{'type': 'number'}, {'type': 'null'}], 'description': 'Total matching records, when calculated'}}, 'additionalProperties': {}}}, 'additionalProperties': {}}

Refine Job Search

このMCPでできること

ツール

最近のツール変更

類似のMCPサーバー

freedom-mcp

Stable Baseline

mcp

TaScan

Tango

AIOProductOS MCP

agendaforge

Chronary