diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 766f1cb..894dcc5 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,29 +1,37 @@ lockVersion: 2.0.0 id: 3a450d25-b36a-4ee1-a439-d28897ecbc3f management: - docChecksum: 4e61b7ebb6f7537f0f63788428d9f306 + docChecksum: 1ab02d7c421f19d0f8ae540706b3e1e9 docVersion: 1.0.0 - speakeasyVersion: 1.653.0 - generationVersion: 2.748.0 - releaseVersion: 0.3.0 - configChecksum: 0f83949ce20b94f06685e7e63a4b59e4 + speakeasyVersion: 1.759.3 + generationVersion: 2.869.25 + releaseVersion: 0.3.1 + configChecksum: 5c62c98eb07c976741f089c3054b9389 repoURL: https://github.com/StackOneHQ/stackone-client-postman.git + installationURL: https://github.com/StackOneHQ/stackone-client-postman +persistentEdits: + generation_id: 4d075e37-17fc-4a5c-b03a-d0476a6bf9b7 + pristine_commit_hash: fffcd9e630cdacc0d8c3f3b9317fe116af470b05 + pristine_tree_hash: 21e7132573ac41a62bf789c3c3840fcab7d74b9f features: postman: acceptHeaders: 0.1.0 - constsAndDefaults: 0.1.0 - core: 0.2.2 + constsAndDefaults: 0.1.2 + core: 0.2.11 deprecations: 0.0.0 - examples: 0.1.1 - globalSecurity: 0.1.3 - globalServerURLs: 0.1.1 + examples: 0.1.2 + globalSecurity: 0.1.4 + globalServerURLs: 0.1.2 groups: 0.1.1 - methodSecurity: 0.1.1 - nameOverrides: 0.1.0 + methodSecurity: 0.1.3 + nameOverrides: 0.1.2 pagination: 0.0.0 retries: 0.0.0 -generatedFiles: - - StackOne_postman_collection.json +trackedFiles: + StackOne_postman_collection.json: + id: 516e0885fbdc + last_write_checksum: sha1:db1c3cc45a460b63ab705fc45d3baeaf175ace8d + pristine_git_object: 0590197d3bf6af35a1ed1714b83e55e57e4661b4 examples: stackone_create_connect_session: speakeasy-default-stackone-create-connect-session: @@ -31,7 +39,7 @@ examples: application/json: {"categories": ["ats", "hris", "documents", "crm", "iam", "marketing", "lms", "iam", "documents", "ticketing", "screening", "messaging", "accounting"], "origin_owner_id": "", "origin_owner_name": "", "expires_in": 1800, "multiple": false, "type": "test"} responses: "201": - application/json: {"id": 480.39, "organization_id": 203.83, "project_id": "", "categories": ["ats", "hris", "messaging", "crm", "iam", "marketing", "lms", "hris-legacy", "documents", "ticketing", "screening", "messaging", "accounting"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2023-11-10T21:31:46.697Z", "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "type": "test", "token": "", "auth_link_url": "https://medium-story.biz/"} + application/json: {"id": 480.39, "organization_id": "203.83", "project_id": "", "categories": ["ats", "hris", "messaging", "crm", "iam", "marketing", "lms", "hris-legacy", "documents", "ticketing", "screening", "messaging", "accounting"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2023-11-10T21:31:46.697Z", "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "type": "test", "token": "", "auth_link_url": "https://medium-story.biz/"} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": null, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -60,7 +68,7 @@ examples: application/json: {"token": ""} responses: "201": - application/json: {"id": 8422.01, "organization_id": 9188.03, "project_id": "", "categories": ["ats", "hris", "messaging", "crm", "iam", "marketing", "lms", "lms", "documents", "ticketing", "screening", "messaging", "accounting"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-10-01T04:59:29.242Z", "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "type": "unmapped_value"} + application/json: {"id": 8422.01, "organization_id": "9188.03", "project_id": "", "categories": ["ats", "hris", "messaging", "crm", "iam", "marketing", "lms", "lms", "documents", "ticketing", "screening", "messaging", "accounting"], "origin_owner_id": "", "origin_owner_name": "", "created_at": "2024-10-01T04:59:29.242Z", "external_trigger_token": "f0bc3d88-2178-5423-8c81-b81d6c9da824", "type": "unmapped_value"} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -399,6 +407,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"url": "https://api.sample-integration.com/v1", "method": "get", "path": "/employees/directory", "headers": {"Content-Type": "application/json"}} responses: @@ -436,6 +445,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}]} @@ -472,6 +482,7 @@ examples: fields: "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}} @@ -507,6 +518,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -544,6 +556,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_1", "value": "Not Started"}, {"id": "option_2", "value": "In Progress"}, {"id": "option_3", "value": "Completed"}]}} @@ -581,6 +594,7 @@ examples: include: "avatar_url,avatar,custom_fields,job_description,benefits,bank_details" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Isaac", "last_name": "Newton", "name": "Isaac Newton", "display_name": "Sir Isaac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_title": "Physicist", "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "team"}}], "remote_manager_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "gender": {}, "preferred_language": {"value": "eng"}, "ethnicity": {}, "date_of_birth": "1990-01-01T00:00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "marital_status": {}, "avatar": {}, "hire_date": "2021-01-01T00:00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "employment_status": {}, "termination_date": "2021-01-01T00:00:00Z", "company_id": "1234567890", "citizenships": [{"value": "US"}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "company": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}, "employments": null, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_numbers": [{"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}], "skills": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}, "maximum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}, "minimum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -613,6 +627,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"title": "Mr", "first_name": "Isaac", "last_name": "Newton", "name": "Isaac Newton", "display_name": "Sir Isaac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_title": "Physicist", "department_id": "3093", "team_id": "2913", "department": "Physics", "manager_id": "67890", "gender": {}, "preferred_language": {"value": "eng"}, "ethnicity": {}, "date_of_birth": "1990-01-01T00:00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "marital_status": {}, "avatar": {}, "hire_date": "2021-01-01T00:00:00.000Z", "start_date": "2021-01-01T00:00:00.000Z", "employment_status": {}, "termination_date": "2021-01-01T00:00:00Z", "company_id": "1234567890", "citizenships": [{"value": "US"}], "employment": null, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "national_identity_numbers": [{"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}, "state": {}}, "work_location": null, "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "R&D", "distribution_percentage": 100}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -653,6 +668,7 @@ examples: include: "avatar_url,avatar,custom_fields,job_description,benefits,bank_details" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Mr", "first_name": "Isaac", "last_name": "Newton", "name": "Isaac Newton", "display_name": "Sir Isaac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_title": "Physicist", "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "team"}}], "gender": {}, "preferred_language": {"value": "eng"}, "ethnicity": {}, "date_of_birth": "1990-01-01T00:00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "marital_status": {}, "avatar": {}, "hire_date": "2021-01-01T00:00:00.000Z", "start_date": "2021-01-01T00:00:00.000Z", "tenure": 2, "work_anniversary": "2021-01-01T00:00:00Z", "employment_status": {}, "termination_date": "2021-01-01T00:00:00Z", "company_id": "1234567890", "citizenships": [{"value": "US"}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": null, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "company": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}, "employments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "end_date": "2021-01-01T01:01:01.000Z", "grade": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "description": "Mid-level employee demonstrating proficiency and autonomy."}, "type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Permanent", "type": {}}, "contract_type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Full-Time", "contract_type": {}}, "work_time": {"duration": "P0Y0M0DT8H0M0S"}, "payroll_code": "PC1", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "fte": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "active": true, "department": null, "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "distribution_percentage": 85, "type": {"value": "team"}}], "division": null, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "description": null, "owner_id": "5356", "parent_id": "7577"}, "manager": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "role": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Admin", "role_type": {"value": "admin"}}}]}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}], "employee_number": "125", "bank_details": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "account_name": "John Doe Primary Account", "is_primary": true, "country_code": {"value": "US"}, "currency_code": {"value": "USD", "source_value": "USD"}, "bank_name": "Chase Bank", "account_type": {"value": "checking", "source_value": "checking"}, "iban": "GB82WEST12345698765432", "local_account_number": "1234567890", "swift_bic": "CHASUS33", "clearing_codes": [{"type": {"value": "sort_code", "source_value": "sort_code"}, "value": "12-34-56"}]}], "national_identity_numbers": [{"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}], "skills": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}, "maximum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}, "minimum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -687,6 +703,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"title": "Mr", "first_name": "Isaac", "last_name": "Newton", "name": "Isaac Newton", "display_name": "Sir Isaac Newton", "avatar_url": "https://example.com/avatar.png", "personal_email": "isaac.newton@example.com", "personal_phone_number": "+1234567890", "work_email": "newton@example.com", "work_phone_number": "+1234567890", "job_title": "Physicist", "department_id": "3093", "team_id": "2913", "department": "Physics", "manager_id": "67890", "gender": {}, "preferred_language": {"value": "eng"}, "ethnicity": {}, "date_of_birth": "1990-01-01T00:00:00.000Z", "birthday": "2021-01-01T00:00:00Z", "marital_status": {}, "avatar": {}, "hire_date": "2021-01-01T00:00:00.000Z", "start_date": "2021-01-01T00:00:00.000Z", "employment_status": {}, "termination_date": "2021-01-01T00:00:00Z", "company_id": "1234567890", "citizenships": [{"value": "US"}], "employment": null, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "benefits": null, "employee_number": "125", "national_identity_numbers": [{"value": "123456789", "type": {"value": "ssn"}, "country": {"value": "US"}}], "home_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}, "state": {}}, "work_location": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "zip_code": "NG33 5NR", "country": {"value": "US"}, "passthrough": {"other_known_names": "John Doe"}, "state": {}}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -723,6 +740,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}} responses: @@ -763,6 +781,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "approver_id": "1687-4", "remote_approver_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000", "end_date": "2021-01-01T01:01:01.000", "start_half_day": true, "end_half_day": true, "duration": "P3Y6M4DT12H30M5S", "time_off_policy_id": "cx280928933", "remote_time_off_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "reason": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "policy": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Holidays", "description": "Usable for regional and national holidays of employees.", "type": {"value": "holiday"}, "duration_unit": {"value": "hours"}, "reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}}]} @@ -797,6 +816,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"approver_id": "1687-4", "start_date": "2021-01-01T01:01:01.000", "end_date": "2021-01-01T01:01:01.000", "start_half_day": true, "end_half_day": true, "time_off_policy_id": "cx280928933", "reason": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "comment": "Taking a day off for personal reasons", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -837,6 +857,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "approver_id": "1687-4", "remote_approver_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000", "end_date": "2021-01-01T01:01:01.000", "start_half_day": true, "end_half_day": true, "duration": "P3Y6M4DT12H30M5S", "time_off_policy_id": "cx280928933", "remote_time_off_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "reason": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "policy": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Holidays", "description": "Usable for regional and national holidays of employees.", "type": {"value": "holiday"}, "duration_unit": {"value": "hours"}, "reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "comment": "Taking a day off for personal reasons"}} @@ -872,6 +893,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"statusCode": 204, "message": "Record deleted successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} @@ -907,6 +929,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"approver_id": "1687-4", "start_date": "2021-01-01T01:01:01.000", "end_date": "2021-01-01T01:01:01.000", "start_half_day": true, "end_half_day": true, "time_off_policy_id": "cx280928933", "reason": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "comment": "Taking a day off for personal reasons", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -1093,6 +1116,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1130,6 +1154,7 @@ examples: fields: "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}} @@ -1165,6 +1190,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1201,6 +1227,7 @@ examples: fields: "id,remote_id,name,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}} @@ -1238,6 +1265,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "sub_type": "H1B", "document": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}, "valid_from": "2021-01-01T00:00:00.000Z", "valid_to": "2021-01-01T00:00:00.000Z", "issued_by": {"value": "US"}, "number": "1234567890"}]} @@ -1272,6 +1300,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"document": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": null}, "issued_by": {"value": "US"}, "number": "1234567890", "sub_type": "H1B", "type": {}, "valid_from": "2021-01-01T00:00:00.000Z", "valid_to": "2021-01-01T00:00:00.000Z", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -1311,6 +1340,7 @@ examples: fields: "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "sub_type": "H1B", "document": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}, "valid_from": "2021-01-01T00:00:00.000Z", "valid_to": "2021-01-01T00:00:00.000Z", "issued_by": {"value": "US"}, "number": "1234567890"}} @@ -1346,6 +1376,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"document": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}, "issued_by": {"value": "US"}, "number": "1234567890", "sub_type": "H1B", "type": {}, "valid_from": "2021-01-01T00:00:00.000Z", "valid_to": "2021-01-01T00:00:00.000Z", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -1384,6 +1415,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1422,6 +1454,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "cx280928937", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "policy_id": "cx280928937", "remote_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "policy": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Holidays", "description": "Usable for regional and national holidays of employees.", "type": {"value": "holiday"}, "duration_unit": {"value": "hours"}, "reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "current_balance": 8, "initial_balance": 8, "balance_unit": {"value": "hours"}, "balance_start_date": "2021-01-01T01:01:01.000Z", "balance_expiry_date": "2021-01-01T01:01:01.000Z", "is_unlimited": true, "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -1458,6 +1491,7 @@ examples: expand: "groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1495,6 +1529,7 @@ examples: expand: "groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "end_date": "2021-01-01T01:01:01.000Z", "grade": null, "type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Permanent", "type": {}}, "contract_type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Full-Time", "contract_type": {}}, "work_time": {"duration": "P0Y0M0DT8H0M0S", "period": {"value": "month"}}, "payroll_code": "PC1", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "fte": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "active": true, "department": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": null}, "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "distribution_percentage": 85, "type": {"value": "team"}}], "division": null, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "description": null, "owner_id": "5356", "parent_id": "7577"}, "manager": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "role": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Admin", "role_type": {"value": "admin"}}}]}} @@ -1533,6 +1568,7 @@ examples: expand: "groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1567,6 +1603,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "end_date": "2021-01-01T01:01:01.000Z", "grade": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "description": "Mid-level employee demonstrating proficiency and autonomy."}, "type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Permanent", "type": {}}, "contract_type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Full-Time", "contract_type": {}}, "work_time": {"duration": "P0Y0M0DT8H0M0S", "period": {"value": "month"}}, "payroll_code": "PC1", "job_id": "5290", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -1607,6 +1644,7 @@ examples: expand: "groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "end_date": "2021-01-01T01:01:01.000Z", "grade": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "description": "Mid-level employee demonstrating proficiency and autonomy."}, "type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Permanent", "type": {}}, "contract_type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Full-Time", "contract_type": {}}, "work_time": {"duration": "P0Y0M0DT8H0M0S", "period": {"value": "month"}}, "payroll_code": "PC1", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "fte": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "active": true, "department": null, "cost_centers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "distribution_percentage": 85, "type": {"value": "team"}}], "division": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "team"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "description": {"text": "Testing the laws of motion"}, "owner_id": "5356", "parent_id": "7577"}, "manager": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "role": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Admin", "role_type": {"value": "admin"}}}]}} @@ -1642,6 +1680,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "job_title": "Software Engineer", "pay_rate": "40.00", "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "pay_currency": "USD", "effective_date": "2021-01-01T01:01:01.000Z", "end_date": "2021-01-01T01:01:01.000Z", "grade": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "description": "Mid-level employee demonstrating proficiency and autonomy."}, "type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Permanent", "type": {}}, "contract_type": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "label": "Full-Time", "contract_type": {}}, "work_time": {"duration": "P0Y0M0DT8H0M0S", "period": {"value": "month"}}, "payroll_code": "PC1", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -1679,6 +1718,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": {"value": "US"}, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -1715,6 +1755,7 @@ examples: fields: "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "name": "Woolsthorpe Manor", "phone_number": "+44 1476 860 364", "street_1": "Water Lane", "street_2": "Woolsthorpe by Colsterworth", "city": "Grantham", "state": "Lincolnshire", "zip_code": "NG33 5NR", "country": null, "location_type": {"value": "home", "source_value": "Home"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -1751,6 +1792,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1788,6 +1830,7 @@ examples: expand: "policy" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "approver_id": "1687-4", "remote_approver_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000", "end_date": "2021-01-01T01:01:01.000", "start_half_day": true, "end_half_day": true, "duration": "P3Y6M4DT12H30M5S", "time_off_policy_id": "cx280928933", "remote_time_off_policy_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "reason": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "policy": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Holidays", "description": "Usable for regional and national holidays of employees.", "type": {"value": "holiday"}, "duration_unit": {"value": "hours"}, "reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "comment": "Taking a day off for personal reasons"}} @@ -1823,6 +1866,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}]} @@ -1859,6 +1903,7 @@ examples: fields: "id,remote_id,name,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}} @@ -1894,6 +1939,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z", "start_time": "2020-01-01T00:00:00.000Z", "end_time": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -1930,6 +1976,7 @@ examples: fields: "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "employee_id": "1687-3", "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_time": "2021-01-01T01:01:01.000Z", "end_time": "2021-01-01T01:01:01.000Z", "hours_worked": 8, "break_duration": 0.5, "labor_type": {"code": "ABC123"}, "location": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}, "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}} @@ -1965,6 +2012,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}]} @@ -2001,6 +2049,7 @@ examples: fields: "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Health Insurance", "provider": "Aetna", "description": "Health insurance for employees", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z"}} @@ -2036,6 +2085,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2071,6 +2121,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2106,6 +2157,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2141,6 +2193,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2177,6 +2230,7 @@ examples: fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "team"}}} @@ -2213,6 +2267,7 @@ examples: fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "department"}}} @@ -2249,6 +2304,7 @@ examples: fields: "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "distribution_percentage": 85, "type": {"value": "team"}}} @@ -2285,6 +2341,7 @@ examples: fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "team"}}} @@ -2320,6 +2377,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2356,6 +2414,7 @@ examples: fields: "id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "code": "184919", "title": "Software Engineer", "description": "Responsible for identifying business requirements", "status": {"value": "open"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -2393,6 +2452,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}, "maximum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}, "minimum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}}]} @@ -2427,6 +2487,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"id": "16873-IT345", "name": "Information-Technology", "maximum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}, "minimum_proficiency": null} responses: @@ -2466,6 +2527,7 @@ examples: fields: "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": null, "maximum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}, "minimum_proficiency": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Expert"}}} @@ -2501,6 +2563,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2537,6 +2600,7 @@ examples: fields: "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Holidays", "description": "Usable for regional and national holidays of employees.", "type": {"value": "holiday"}, "duration_unit": {"value": "hours"}, "reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -2574,6 +2638,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2608,10 +2673,11 @@ examples: id: "" query: fields: "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} expand: "attachments" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "cx280928937", "name": "Complete onboarding documents", "description": "Please complete all required onboarding documents in the employee portal", "type": {"value": "action"}, "status": {"value": "open"}, "due_date": "2024-03-20T23:59:59.000Z", "completion_date": "2024-03-19T15:30:00.000Z", "assigned_by_employee_id": "cx280928938", "assigned_by_employee_name": "John Smith", "link_to_task": "https://provider.com/tasks/123", "extracted_links": ["https://provider.com/docs/1", "https://provider.com/forms/2"], "next_task_id": "cx280928939", "parent_process_name": "Onboarding Tasks", "comments": [{"comment": "Approved based on in-person assessment", "created_at": "2024-03-15T10:00:00.000Z"}], "attachments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}], "created_at": "2024-03-15T10:00:00.000Z", "updated_at": "2024-03-19T15:30:00.000Z"}]} @@ -2650,6 +2716,7 @@ examples: expand: "attachments" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": null} @@ -2687,6 +2754,7 @@ examples: include: "attachments,custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -2719,6 +2787,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "job_posting_id": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51", "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", "application_status": null, "questionnaires": [{"id": "right_to_work", "answers": [{"id": "answer1", "type": {"value": "short_text", "source_value": "Short Text"}, "values": ["Yes"]}]}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "candidate": {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_numbers": [{"phone": "+447700112233"}], "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}, "documents": null} responses: @@ -2759,6 +2828,7 @@ examples: include: "attachments,custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "remote_job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", "application_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Review", "order": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "application_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "remote_application_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reasons": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}], "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "remote_rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "rejected_at": "2021-01-01T01:01:01.000Z", "location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "remote_location_ids": ["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"], "application_status": {"value": "hired", "source_value": "Hired"}, "questionnaires": [{"id": "right_to_work", "answers": [{"id": "answer1", "type": {"value": "short_text", "source_value": "Short Text"}, "values": ["Yes"]}]}], "candidate": null, "documents": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}], "result_links": [{"label": "test result link", "url": "http://example.com/test-result/4565765/data"}], "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]}} @@ -2793,6 +2863,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "application_status": {"value": "hired", "source_value": "Hired"}, "source": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "LinkedIn"}} responses: @@ -2832,6 +2903,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}]} @@ -2866,6 +2938,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "interview_stage_id": "f223d7f6-908b-48f0-9237-b201c307f609"} responses: @@ -2902,6 +2975,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "rejected_reason_id": "f223d7f6-908b-48f0-9237-b201c307f609"} responses: @@ -2941,6 +3015,7 @@ examples: fields: "id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}} @@ -2978,6 +3053,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -3015,6 +3091,7 @@ examples: fields: "id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "sections": null, "label": "Technical Interview", "candidate_id": "5678-9", "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "application_id": "1011-12", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_id": "1314-15", "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "author_id": "1617-18", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "overall_recommendation": "no_decision", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} @@ -3052,6 +3129,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "visibility": {"value": "public", "source_value": "Public"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}]} @@ -3086,6 +3164,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "visibility": {"value": "public", "source_value": "Public"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -3125,6 +3204,7 @@ examples: fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "visibility": {"value": "public", "source_value": "Public"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}} @@ -3160,6 +3240,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "visibility": {"value": "public", "source_value": "Public"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -3199,6 +3280,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -3236,6 +3318,7 @@ examples: fields: "id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -3384,6 +3467,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -3421,6 +3505,7 @@ examples: fields: "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}} @@ -3457,6 +3542,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": null, "phone_numbers": [{"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -3489,6 +3575,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "phone_numbers": [{"phone": "+447700112233"}], "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "company": "Company Inc.", "title": "Software Engineer", "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} responses: @@ -3530,6 +3617,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "remote_application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "tags": [{"remote_id": "123e4567-e89b-12d3-a456-426614174000", "name": "Gold Medalist"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -3564,6 +3652,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Romain Sestier", "first_name": "Romain", "last_name": "Sestier", "email": "sestier.romain123@gmail.com", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "social_links": [{"type": "linkedin", "url": "https://www.linkedin.com/in/romainsestier/"}], "phone_numbers": [{"phone": "+447700112233"}], "company": "Company Inc.", "title": "Software Engineer", "application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"], "hired_at": "2021-01-01T01:01:01.000Z", "country": "United States", "custom_fields": null} responses: @@ -3603,6 +3692,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "visibility": {"value": "public", "source_value": "Public"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}]} @@ -3637,6 +3727,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "visibility": {"value": "public", "source_value": "Public"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -3676,6 +3767,7 @@ examples: fields: "id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "visibility": {"value": "public", "source_value": "Public"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "deleted_at": "2021-01-01T01:01:01.000Z"}} @@ -3711,6 +3803,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -3748,6 +3841,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_1", "value": "Not Started"}, {"id": "option_2", "value": "In Progress"}, {"id": "option_3", "value": "Completed"}]}} @@ -3783,6 +3877,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -3820,6 +3915,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_1", "value": "Not Started"}, {"id": "option_2", "value": "In Progress"}, {"id": "option_3", "value": "Completed"}]}} @@ -3855,6 +3951,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}]}]} @@ -3892,6 +3989,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_1", "value": "Not Started"}, {"id": "option_2", "value": "In Progress"}, {"id": "option_3", "value": "Completed"}]}} @@ -3927,6 +4025,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}]} @@ -3963,6 +4062,7 @@ examples: fields: "id,remote_id,name,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}} @@ -3998,6 +4098,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4034,6 +4135,7 @@ examples: fields: "id,remote_id,name,order,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -4069,6 +4171,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -4105,6 +4208,7 @@ examples: fields: "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "interview_stage": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "interview_status": {"value": "unscheduled", "source_value": "Unscheduled"}, "remote_interviewer_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "interview_parts": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "on_site", "source_value": "Onsite Interview"}, "title": "Interview (Informal Interview) - Elon and StackOne", "interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "remote_interviewer_ids": ["cx28iQahdfDHa", "cx28iQokkD78das"], "meeting_url": "zoomus://zoom.us/join?confno=123456789", "meeting_provider": "zoom", "start_at": "2021-01-01T17:00:00.000Z", "end_at": "2021-01-01T18:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "interviewers": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "start_at": "2021-01-01T01:01:01.000Z", "end_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -4142,6 +4246,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4174,6 +4279,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "description": "Responsible for identifying business requirements", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -4214,6 +4320,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "description": "Responsible for identifying business requirements", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "remote_department_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48"], "location_ids": ["668570", "678571", "688572"], "remote_location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": null, "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -4248,6 +4355,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "code": "184919", "title": "Software Engineer", "description": "Responsible for identifying business requirements", "job_status": {"value": "published", "source_value": "Published"}, "department_ids": ["308570", "308571", "308572"], "location_ids": ["668570", "678571", "688572"], "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "interview_stages": null, "custom_fields": null, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -4285,6 +4393,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4321,6 +4430,7 @@ examples: fields: "id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} @@ -4356,6 +4466,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}]} @@ -4392,6 +4503,7 @@ examples: fields: "id,remote_id,name,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}}} @@ -4427,6 +4539,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4463,6 +4576,7 @@ examples: fields: "id,remote_id,label,type,rejected_reason_type,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "label": "Failed Phone Screen", "rejected_reason_type": {"value": "rejected_by_organization", "source_value": "RejectedByOrg"}}} @@ -4498,6 +4612,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4534,6 +4649,7 @@ examples: fields: "id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -4570,6 +4686,7 @@ examples: include: "questionnaires" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4607,9 +4724,10 @@ examples: include: "questionnaires" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": - application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "name": "New York"}, {"id": "67890", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

"}, "compensation": [{"title": "Base Salary", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "50000", "min_value_range": "45000", "max_value_range": "55000"}, {"title": "Bonus", "type": {"value": "salary", "source_value": "Salary"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "name": "About", "internal": "false", "questions": [{"id": "question001", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your name?", "required": true, "parent_question": null}, {"id": "question002", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What are your hobbies?", "required": false, "parent_question": null}, {"id": "question003", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your favourite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Dog"}, {"id": "2", "text": "Cat"}, {"id": "3", "text": "Bird"}, {"id": "4", "text": "Other"}], "parent_question": null}, {"id": "question004", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Do you have previous work experience??", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question005", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What was the duration of your last employment?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Less than 1 year"}, {"id": "2", "text": "1-2 years"}, {"id": "2", "text": "More than 2 year"}], "parent_question": {"id": "question004", "option_ids": ["1"], "condition_type": {"value": "equals_to", "source_value": "EqualsTo"}}}]}, {"id": "experience001", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Please upload your resume.", "required": true, "parent_question": null}, {"id": "question005", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "text": "JavaScript"}, {"id": "2", "text": "Python"}, {"id": "3", "text": "Java"}], "parent_question": null}, {"id": "question006", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Are you willing to relocate?", "parent_question": null}, {"id": "question007", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How many years of experience do you have?", "parent_question": null}, {"id": "question008", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "When did you start your most recent position?", "parent_question": null}, {"id": "question009", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Do you have Project Management Experience?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question010", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How much Project Management experience do you have?", "multiple_choice_answers": [{"id": "1", "text": "1-3 years"}, {"id": "2", "text": "3-5 years"}, {"id": "3", "text": "5-10 years"}, {"id": "4", "text": "More than 10 years"}], "parent_question": {"id": "question009", "option_ids": ["1"], "condition_type": {"value": "equals_to", "source_value": "EqualsTo"}}}]}], "start_date": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} + application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer", "locations": [{"id": "12345", "name": "New York"}, {"id": "67890", "name": "Remote"}], "internal": "true", "status": {"value": "live", "source_value": "Live"}, "job_id": "job001", "remote_job_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "content": {"plain": "This is a plain text description", "html": "

This is an HTML description

"}, "compensation": [{"title": "Base Salary", "type": {"value": "salary", "source_value": "Salary"}, "pay_period": {"value": "hour", "source_value": "Hour"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "50000", "min_value_range": "45000", "max_value_range": "55000"}, {"title": "Bonus", "type": {"value": "salary", "source_value": "Salary"}, "pay_frequency": {"value": "hourly", "source_value": "Hourly"}, "currency": "USD", "value": "10%"}], "employment_type": {"value": "permanent", "source_value": "Permanent"}, "employment_contract_type": {"value": "full_time", "source_value": "FullTime"}, "external_url": "https://www.example.com/job-posting/abcd1234", "external_apply_url": "https://www.example.com/job-posting/abcd1234/apply", "questionnaires": [{"id": "about001", "name": "About", "internal": "false", "questions": [{"id": "question001", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your name?", "required": true, "parent_question": null}, {"id": "question002", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What are your hobbies?", "required": false, "parent_question": null}, {"id": "question003", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What is your favourite animal?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Dog"}, {"id": "2", "text": "Cat"}, {"id": "3", "text": "Bird"}, {"id": "4", "text": "Other"}], "parent_question": null}, {"id": "question004", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Do you have previous work experience??", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question005", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "What was the duration of your last employment?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Less than 1 year"}, {"id": "2", "text": "1-2 years"}, {"id": "2", "text": "More than 2 year"}], "parent_question": {"id": "question004", "option_ids": ["1"], "condition_type": {"value": "equals_to", "source_value": "EqualsTo"}}}]}, {"id": "experience001", "name": "Experience", "internal": "false", "questions": [{"id": "question004", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Please upload your resume.", "required": true, "parent_question": null}, {"id": "question005", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Select the programming languages you are proficient in.", "required": true, "multiple_choice_answers": [{"id": "1", "text": "JavaScript"}, {"id": "2", "text": "Python"}, {"id": "3", "text": "Java"}], "parent_question": null}, {"id": "question006", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Are you willing to relocate?", "parent_question": null}, {"id": "question007", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How many years of experience do you have?", "parent_question": null}, {"id": "question008", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "When did you start your most recent position?", "parent_question": null}, {"id": "question009", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "Do you have Project Management Experience?", "required": true, "multiple_choice_answers": [{"id": "1", "text": "Yes"}, {"id": "2", "text": "No"}], "parent_question": null}, {"id": "question010", "type": {"value": "short_text", "source_value": "ShortText"}, "text": "How much Project Management experience do you have?", "multiple_choice_answers": [{"id": "1", "text": "1-3 years"}, {"id": "2", "text": "3-5 years"}, {"id": "3", "text": "5-10 years"}, {"id": "4", "text": "More than 10 years"}], "parent_question": {"id": "question009", "option_ids": ["1"], "condition_type": {"value": "equals_to", "source_value": "EqualsTo"}}}]}], "start_date": "2021-01-01T00:00:00.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -4642,6 +4760,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -4674,6 +4793,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -4714,6 +4834,7 @@ examples: fields: "id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "start_date": "2021-01-01T01:01:01.000Z", "offer_status": {"value": "pending", "source_value": "Pending"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "offer_history": [{"start_date": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]}} @@ -4748,6 +4869,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]} @@ -4782,6 +4904,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}} @@ -4814,6 +4937,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}, "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "title": "Software Engineer", "hiring_team": [{"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}], "passthrough": {"other_known_names": "John Doe"}}, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "passthrough": {"other_known_names": "John Doe"}} responses: @@ -4886,6 +5010,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"score": null, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}], "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -4959,6 +5084,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}]} @@ -4991,6 +5117,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5029,6 +5156,7 @@ examples: fields: "id,remote_id,name,description,tests,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}} @@ -5063,6 +5191,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"statusCode": 204, "message": "Record deleted successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} @@ -5097,6 +5226,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5166,6 +5296,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "application_status": {"value": "hired", "source_value": "Hired"}, "passthrough": {"other_known_names": "John Doe"}}, "job": null, "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "first_name": "Romain", "last_name": "Sestier", "emails": [{"type": "personal", "value": "sestier.romain123@gmail.com"}], "passthrough": {"other_known_names": "John Doe"}, "profile_url": "https://exmaple.com/candidate?id=xyz"}, "requester": {"user_id": "123456", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "first_name": "John", "last_name": "Doe", "email": "john.doe@gmail.com", "role": "Software Engineer"}, "results_update_url": "https://exmaple.com/integrations/results/update", "package": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills", "tests": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Test 1", "description": "Skills test to gauge a candidate's proficiency in job-specific skills"}]}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5238,6 +5369,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"score": {"label": "Percentage", "value": "80", "min": "0", "max": "100"}, "start_date": "2021-01-01T01:01:01.000Z", "submission_date": "2021-01-01T01:01:01.000Z", "summary": "Test is passed", "result": {"value": "passed", "source_value": "Passed"}, "result_url": "https://exmaple.com/result?id=xyz", "attachments": [{"url": "http://example.com/resume.pdf", "content_type": {"value": "text", "source_value": "Text"}}], "candidate": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "profile_url": "https://exmaple.com/candidate?id=xyz"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5312,6 +5444,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": null, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -5344,6 +5477,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5383,6 +5517,7 @@ examples: include: "custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "remote_deal_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "account_ids": ["account-123", "account-456"], "remote_account_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "custom_fields": null, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -5417,6 +5552,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"first_name": "Steve", "last_name": "Wozniak", "company_name": "Apple Inc.", "emails": ["steve@apple.com"], "phone_numbers": ["123-456-7890"], "deal_ids": ["deal-001", "deal-002"], "account_ids": ["account-123", "account-456"], "custom_fields": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Training Completion Status", "value": "Completed", "value_id": "value_456", "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5454,6 +5590,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": null, "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -5490,6 +5627,7 @@ examples: fields: "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "industries": ["Information Technology", "Airlines & Airports", "Personal Care & Household Products"], "addresses": [{"country": {"value": "GB", "source_value": "GB"}, "location_type": {"value": "home", "source_value": "Home"}}], "phone_numbers": ["+1123425334"], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -5525,6 +5663,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}]} @@ -5561,6 +5700,7 @@ examples: fields: "id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "items": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "type": {"value": "contacts", "source_value": "Contacts"}}} @@ -5596,6 +5736,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}, {"id": "option_123", "value": "Not Started"}]}]} @@ -5633,6 +5774,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {}, "options": [{"id": "option_1", "value": "Not Started"}, {"id": "option_2", "value": "In Progress"}, {"id": "option_3", "value": "Completed"}]}} @@ -5669,6 +5811,7 @@ examples: expand: "roles,groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": null, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": null, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}}]} @@ -5706,6 +5849,7 @@ examples: expand: "roles,groups" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "groups": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "status": {"value": "enabled"}, "last_active_at": "2021-01-01T01:01:01.000Z", "last_login_at": "2021-01-01T01:01:01.000Z", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "multi_factor_enabled": [{"value": "totp"}], "avatar": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}}} @@ -5740,6 +5884,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"statusCode": 204, "message": "Record deleted successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} @@ -5774,6 +5919,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"primary_email_address": "han@stackone.com", "first_name": "Han", "last_name": "Solo", "name": "Han Solo", "username": "hansolo1977", "is_bot_user": true, "status": {"value": "enabled"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -5812,6 +5958,7 @@ examples: expand: "policies" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -5849,6 +5996,7 @@ examples: expand: "policies" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -5885,6 +6033,7 @@ examples: expand: "roles" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": null, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -5922,6 +6071,7 @@ examples: expand: "roles" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "team"}, "roles": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "admin"}, "policies": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -5958,6 +6108,7 @@ examples: expand: "permissions" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -5995,6 +6146,7 @@ examples: expand: "permissions" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Remote Contractor Policy", "permissions": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "read:users", "type": {"value": "read_write"}, "resources": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Company History Records", "location": "s3://bucket-name/folder-name", "type": {"value": "file"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -6030,6 +6182,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} @@ -6062,6 +6215,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": null}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6100,6 +6254,7 @@ examples: fields: "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} @@ -6134,6 +6289,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6171,6 +6327,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}]} @@ -6203,6 +6360,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6241,6 +6399,7 @@ examples: fields: "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}]}} @@ -6275,6 +6434,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6312,6 +6472,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -6344,6 +6505,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6382,6 +6544,7 @@ examples: fields: "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": null}} @@ -6416,6 +6579,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6453,6 +6617,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -6485,6 +6650,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6523,6 +6689,7 @@ examples: fields: "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} @@ -6557,6 +6724,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6594,6 +6762,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -6626,6 +6795,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6664,6 +6834,7 @@ examples: fields: "id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z", "messages": null}} @@ -6698,6 +6869,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"messages": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "message_type": {"value": "email", "source_value": "Email"}}], "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6735,6 +6907,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -6771,6 +6944,7 @@ examples: fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z", "schedule_type": null, "status": {"value": "draft", "source_value": "Email"}, "channels": [{"value": "sms", "source_value": "SMS"}], "first_sent_at": "2021-01-01T01:01:01.000Z", "last_sent_at": "2021-01-01T01:01:01.000Z", "messages": [{"id": "message-id-1", "name": "SMS Message", "message_type": {"value": "sms"}, "message_content": {"body": "This is an example SMS body.", "from": "1-555-123-4567"}}, {"id": "message-id-2", "name": "Email Message", "message_type": {"value": "email"}, "message_content": {"subject": "Example Email Subject", "body": "

This is an example

\n

email body

", "from": "Jane Smith", "reply-to": "reply@example.com", "preheader": "This is the preheader of the email."}}, {"id": "message-id-3", "name": "iOS Push Message", "message_type": {"value": "ios_push"}, "message_content": {"body": "This is an example push notification body."}}]}} @@ -6806,6 +6980,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -6838,6 +7013,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6876,6 +7052,7 @@ examples: fields: "id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "html", "source_value": "text"}, "status": {"value": "live", "source_value": "active"}, "created_at": "2021-01-01T00:00:00.000Z", "updated_at": "2021-01-01T00:00:00.000Z"}} @@ -6910,6 +7087,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"type": {"value": "html", "source_value": "text"}, "passthrough": {"other_known_names": "John Doe"}} responses: @@ -6981,6 +7159,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "provider": "Course Provider", "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}]} @@ -7051,6 +7230,7 @@ examples: fields: "id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "content_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_content_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This course acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "cover_url": "https://www.googledrive.com/?v=16873", "url": "https://www.linkedinlearning.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "provider": "Course Provider", "authors": [{"id": "123", "name": "John Doe"}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}} @@ -7090,6 +7270,7 @@ examples: remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -7124,8 +7305,9 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "progress": 40, "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "learning_object_external_reference": "learning-content-123"} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "progress": 40, "assigned_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "learning_object_external_reference": "learning-content-123"} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -7161,9 +7343,10 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": 40, "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": null, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "certificate_url": "https://example.com/certificate/12345", "completed_at": "2021-07-21T14:00:00.000Z"}} + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": 40, "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "assigned_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": null, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "certificate_url": "https://example.com/certificate/12345", "completed_at": "2021-07-21T14:00:00.000Z"}} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -7193,6 +7376,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"items": [{"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "12345", "name": "Sales Techniques"}], "order": 1, "localizations": [{"title": "Software Engineer Lv 1", "description": "This course acts as learning resource for software engineers."}, {"title": "Software Engineer: A comprehensive guide", "description": "This course acts as learning resource for software engineers."}], "tags": ["Sales Techniques", "Customer Service"], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "additional_data": [{"id": "learning_outcomes", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "value": "This is additional data"}]}]} responses: @@ -7230,6 +7414,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_course_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "order": 1, "provider": "Content Provider", "localizations": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers."}], "tags": ["Sales Techniques", "Customer Service"], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}]} @@ -7262,8 +7447,9 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: - application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "12345", "name": "Sales Techniques"}], "order": 1, "localizations": [{"title": "Software Engineer Lv 1", "description": "This course acts as learning resource for software engineers."}, {"title": "Software Engineer: A comprehensive guide", "description": "This course acts as learning resource for software engineers."}], "tags": ["Sales Techniques", "Customer Service"], "authors": [{"id": "123", "name": "John Doe"}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "additional_data": [{"id": "learning_outcomes", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "value": "This is additional data"}]} + application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "skills": [{"id": "12345", "name": "Sales Techniques"}], "order": 1, "localizations": [{"title": "Software Engineer Lv 1", "description": "This course acts as learning resource for software engineers."}, {"title": "Software Engineer: A comprehensive guide", "description": "This course acts as learning resource for software engineers."}], "tags": ["Sales Techniques", "Customer Service"], "authors": [{"id": "123", "name": "John Doe"}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "passthrough": {"other_known_names": "John Doe"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "categories": [{"id": "16873-IT345", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "language": {"value": "en_GB"}}], "additional_data": [{"id": "learning_outcomes", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "value": "This is additional data"}]} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"}} @@ -7300,6 +7486,7 @@ examples: fields: "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", "course_ids": ["16873-SOFTWARE-ENG-COURSE", "16874-SOFTWARE-ENG-COURSE"], "remote_course_ids": ["e3cb75bf-aa84-466e-a6c1-b8322b257a48", "e3cb75bf-aa84-466e-a6c1-b8322b257a49"], "title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers.", "languages": [{"value": "en_GB"}], "content_url": "https://www.youtube.com/watch?v=16873", "mobile_launch_content_url": "https://www.mobile.youtube.com/watch?v=16873", "cover_url": "https://www.googledrive.com/?v=16873", "active": true, "duration": "P3Y6M4DT12H30M5S", "categories": [{"id": "12345", "name": "Technology"}], "skills": [{"id": "12345", "name": "Sales Techniques"}], "order": 1, "provider": "Content Provider", "localizations": [{"title": "Software Engineer Lv 1", "description": "This video acts as learning content for software engineers."}], "tags": ["Sales Techniques", "Customer Service"], "authors": [{"id": "123", "name": "John Doe"}], "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z"}} @@ -7373,6 +7560,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} @@ -7407,8 +7595,9 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: - application/json: {"passthrough": {"other_known_names": "John Doe"}, "completed_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "time_spent": "PT1H30M45S", "learning_object_external_reference": "learning-content-123"} + application/json: {"passthrough": {"other_known_names": "John Doe"}, "completed_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "time_spent": "PT1H30M45S", "score": {"percentage": 87, "raw_value": "87 / 100"}, "learning_object_external_reference": "learning-content-123"} responses: "201": application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} @@ -7444,9 +7633,10 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "time_spent": "PT1H30M45S", "certificate_url": "https://example.com/certificate/12345"}} + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "time_spent": "PT1H30M45S", "certificate_url": "https://example.com/certificate/12345", "score": {"percentage": 87, "raw_value": "87 / 100"}}} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -7479,6 +7669,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"statusCode": 204, "message": "Record deleted successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} @@ -7514,6 +7705,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"}]} @@ -7548,9 +7740,10 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "time_spent": "PT1H30M45S", "certificate_url": "https://example.com/certificate/12345"}} + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_external_reference": "learning-content-123", "completed_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "updated_at": "2021-07-21T14:00:00.000Z", "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "time_spent": "PT1H30M45S", "certificate_url": "https://example.com/certificate/12345", "score": {"percentage": 87, "raw_value": "87 / 100"}}} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": null} "401": @@ -7584,6 +7777,7 @@ examples: fields: "id,remote_id,name,active,hierarchy,level,language,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}}} @@ -7619,6 +7813,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -7654,6 +7849,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -7690,6 +7886,7 @@ examples: fields: "id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -7726,6 +7923,7 @@ examples: fields: "id,remote_id,name,active,hierarchy,language,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}}} @@ -7761,6 +7959,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "active": true, "language": {"value": "en_GB"}}]} @@ -7798,6 +7997,7 @@ examples: remote_user_id: "e3cb75bf-aa84-466e-a6c1-b8322b257a48" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -7832,9 +8032,10 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": - application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": 40, "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "certificate_url": "https://example.com/certificate/12345", "completed_at": "2021-07-21T14:00:00.000Z"}} + application/json: {"data": {"id": "123456", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "learning_object_id": "e3gd34-23tr21-er234-345er56", "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49", "learning_object_external_reference": "learning-content-123", "progress": 40, "updated_at": "2021-07-21T14:00:00.000Z", "created_at": "2021-07-21T14:00:00.000Z", "assigned_at": "2021-07-21T14:00:00.000Z", "due_date": "2021-07-21T14:00:00.000Z", "status": {"value": "in_progress"}, "user_id": "c28xyrc55866bvuv", "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "certificate_url": "https://example.com/certificate/12345", "completed_at": "2021-07-21T14:00:00.000Z"}} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -7969,6 +8170,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -8004,6 +8206,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}]} @@ -8040,6 +8243,7 @@ examples: fields: "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Engineering", "parent_ids": ["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"], "remote_parent_ids": ["652434", "6437241"], "owner_ids": ["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"], "remote_owner_ids": ["475364", "4327652"], "company_id": "1234567890", "remote_company_id": "1234567890", "type": {"value": "division"}}} @@ -8076,6 +8280,7 @@ examples: fields: "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "StackOne Technologies PLC", "full_name": "American Express Company", "display_name": "StackOne", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}} @@ -8111,6 +8316,7 @@ examples: status: "open" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "job_id": "JOB-12345", "title": "Senior Software Engineer", "description": "Responsible for developing and maintaining software applications", "department_id": "dept-123", "location_id": "loc-456", "employment_type": "full-time", "status": {"value": "open"}, "posted_date": "2024-01-15T10:00:00.000Z"}]} @@ -8145,6 +8351,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "job_id": "JOB-12345", "title": "Senior Software Engineer", "description": "Responsible for developing and maintaining software applications", "department_id": "dept-123", "location_id": "loc-456", "employment_type": "full-time", "status": {"value": "open"}, "posted_date": "2024-01-15T10:00:00.000Z"}} @@ -8179,6 +8386,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z", "starts_after": "2024-01-15T09:00", "ends_before": "2024-01-15T17:00"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "emp_123456789", "location_id": "loc_123456789", "company_id": "comp_123456789", "start_time": "2024-03-20T09:00:00Z", "end_time": "2024-03-20T17:00:00Z", "break_duration": "PT1H30M", "status": {"value": "confirmed", "source_value": "Confirmed"}, "approval_status": {"value": "approved", "source_value": "Approved"}, "breaks": [{"id": "break_123456789", "start_time": "2024-03-20T12:00:00Z", "end_time": "2024-03-20T13:00:00Z", "duration": "PT1H", "is_paid": true, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z"}], "created_at": "2024-03-20T08:00:00Z", "updated_at": "2024-03-20T08:00:00Z"}]} @@ -8213,6 +8421,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "emp_123456789", "location_id": "loc_123456789", "company_id": "comp_123456789", "start_time": "2024-03-20T09:00:00.000", "end_time": "2024-03-20T17:00:00.000", "break_duration": "PT1H30M", "status": {"value": "confirmed", "source_value": "Confirmed"}, "approval_status": {"value": "approved", "source_value": "Approved"}, "breaks": [{"id": "break_123456789", "start_time": "2024-03-20T12:00:00Z", "end_time": "2024-03-20T13:00:00Z", "duration": "PT1H", "is_paid": true, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z"}], "created_at": "2024-03-20T08:00:00Z", "updated_at": "2024-03-20T08:00:00Z"}} @@ -8248,6 +8457,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"comment": "All required documents have been submitted", "status": {"value": "open"}} responses: @@ -8282,10 +8492,11 @@ examples: parameters: query: fields: "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields" - filter: {"updated_after": "2020-01-01T00:00:00.000Z"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "created_after": "2020-01-01T00:00:00.000Z"} expand: "attachments" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "cx280928937", "name": "Complete onboarding documents", "description": "Please complete all required onboarding documents in the employee portal", "type": {"value": "action"}, "status": {"value": "open"}, "due_date": "2024-03-20T23:59:59.000Z", "completion_date": "2024-03-19T15:30:00.000Z", "assigned_by_employee_id": "cx280928938", "assigned_by_employee_name": "John Smith", "link_to_task": "https://provider.com/tasks/123", "extracted_links": ["https://provider.com/docs/1", "https://provider.com/forms/2"], "next_task_id": "cx280928939", "parent_process_name": "Onboarding Tasks", "comments": null, "attachments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": null}], "created_at": "2024-03-15T10:00:00.000Z", "updated_at": "2024-03-19T15:30:00.000Z"}]} @@ -8323,6 +8534,7 @@ examples: expand: "attachments" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "cx280928937", "name": "Complete onboarding documents", "description": "Please complete all required onboarding documents in the employee portal", "type": {"value": "action"}, "status": {"value": "open"}, "due_date": "2024-03-20T23:59:59.000Z", "completion_date": "2024-03-19T15:30:00.000Z", "assigned_by_employee_id": "cx280928938", "assigned_by_employee_name": "John Smith", "link_to_task": "https://provider.com/tasks/123", "extracted_links": ["https://provider.com/docs/1", "https://provider.com/forms/2"], "next_task_id": "cx280928939", "parent_process_name": "Onboarding Tasks", "comments": [{"comment": "Approved based on in-person assessment", "created_at": "2024-03-15T10:00:00.000Z"}], "attachments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "My Document", "category": {}, "category_id": "6530", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-02T01:01:01.000Z", "remote_url": "https://example.com/file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}}], "created_at": "2024-03-15T10:00:00.000Z", "updated_at": "2024-03-19T15:30:00.000Z"}} @@ -8360,6 +8572,7 @@ examples: filter: {"created_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "created_at": "2024-01-15T10:30:00Z", "effective_at": "2024-01-15T10:30:00Z", "actor": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}, "change_type": {"value": "application_status", "source_value": "StatusChange"}, "new_values": {"interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480", "rejected_reason_ids": ["f223d7f6-908b-48f0-9237-b201c307f609"], "application_status": null}}]} @@ -8397,6 +8610,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Review", "order": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -8434,6 +8648,7 @@ examples: fields: "id,remote_id,name,order,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Review", "order": 1, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -8469,6 +8684,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}]} @@ -8505,6 +8721,7 @@ examples: fields: "id,remote_id,name,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "1687-3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "1687-4", "active": true}} @@ -8540,6 +8757,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "System outage in production environment", "creator_id": "user-001", "reporters": ["user-001", "user-002"], "assignees": ["user-001", "user-002"], "content": [{"plain": "This is some content", "html": "

This is some content

"}], "parent_id": "ticket-002", "priority": {"id": "001", "value": "medium", "source_value": "Normal"}, "tags": ["tag-001", "tag-002"], "projects": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Project Falcon", "description": "Description of the project", "organization_id": "organization-001", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "ticket_number": "ticket-001", "type": {"id": "001", "name": "Task", "project_id": "project-001"}, "closed_at": "2021-01-01T01:01:01.000Z", "ticket_url": "https://help.company.com/tickets/SUP-5689", "status": {"id": "001", "type": {"value": "to-do", "source_value": "New"}, "name": "Backlog"}, "organization": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "domain": "company.com", "name": "Company"}, "components": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "organization_id": "organization-001", "project_id": "project-001", "name": "Component Falcon", "description": "Description of the component", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -8572,6 +8790,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "System outage in production environment", "creator_id": "user-001", "reporters": ["user-001", "user-002"], "assignees": ["user-001", "user-002"], "content": [{"plain": "This is some content", "html": "

This is some content

"}], "parent_id": "ticket-002", "priority": {"id": "001", "value": "medium", "source_value": "Normal"}, "tags": ["tag-001", "tag-002"], "organization_id": "organization-001", "project_id": "project-001", "component_ids": "[\"component-001\",\"component-002\"]", "type": "ticket-type-001"} responses: @@ -8610,6 +8829,7 @@ examples: fields: "id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "System outage in production environment", "creator_id": "user-001", "reporters": ["user-001", "user-002"], "assignees": ["user-001", "user-002"], "content": [{"plain": "This is some content", "html": "

This is some content

"}], "parent_id": "ticket-002", "priority": {"id": "001", "value": "medium", "source_value": "Normal"}, "tags": ["tag-001", "tag-002"], "projects": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Project Falcon", "description": "Description of the project", "organization_id": "organization-001", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "ticket_number": "ticket-001", "type": null, "closed_at": "2021-01-01T01:01:01.000Z", "ticket_url": "https://help.company.com/tickets/SUP-5689", "status": {"id": "001", "type": {"value": "to-do", "source_value": "New"}, "name": "Backlog"}, "organization": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "domain": "company.com", "name": "Company"}, "components": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "organization_id": "organization-001", "project_id": "project-001", "name": "Component Falcon", "description": "Description of the component", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -8644,6 +8864,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "title": "System outage in production environment", "reporters": ["user-001", "user-002"], "assignees": ["user-001", "user-002"], "content": [{"plain": "This is some content", "html": "

This is some content

"}], "parent_id": "ticket-002", "priority": {"id": "001", "value": "medium", "source_value": "Normal"}, "tags": ["tag-001", "tag-002"], "project_id": "project-001", "component_ids": "[\"component-001\",\"component-002\"]", "status": {"id": "001", "type": {"value": "to-do", "source_value": "New"}, "name": "Backlog"}} responses: @@ -8681,6 +8902,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": null, "name": "John Doe", "primary_email": "john.doe@example.com", "primary_phone": "555-5555-5555", "username": "johndoe", "active": true, "first_name": "John", "last_name": "Doe", "customer_account_reference": "JohnDoe123", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -8717,6 +8939,7 @@ examples: fields: "id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "type": {"value": "agent", "source_value": "Live"}, "name": "John Doe", "primary_email": "john.doe@example.com", "primary_phone": "555-5555-5555", "username": "johndoe", "active": true, "first_name": "John", "last_name": "Doe", "customer_account_reference": "JohnDoe123", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -8754,6 +8977,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "ticket_id": "ticket-001", "user_id": "user-001", "internal": false, "content": [{"plain": "This is some content", "html": "

This is some content

"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -8791,6 +9015,7 @@ examples: fields: "id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "ticket_id": "ticket-001", "user_id": "user-001", "internal": false, "content": [{"plain": "This is some content", "html": "

This is some content

"}], "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -8866,6 +9091,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "ticket_id": "ticket-001", "user_id": "user-001", "file_name": "file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "file_url": "https://example.com/files/screenshot.png", "size": 1024, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -8903,6 +9129,7 @@ examples: fields: "id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "ticket_id": "ticket-001", "user_id": "user-001", "file_name": "file.pdf", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "file_url": "https://example.com/files/screenshot.png", "size": 1024, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -8938,6 +9165,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "001", "name": "Task", "project_id": "project-001"}]} @@ -8974,6 +9202,7 @@ examples: fields: "id,remote_id,name,project_id,remote_project_id,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "001", "name": "Task", "project_id": "project-001"}} @@ -9009,6 +9238,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Project Falcon", "description": "Description of the project", "organization_id": "organization-001", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -9045,6 +9275,7 @@ examples: fields: "id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Project Falcon", "description": "Description of the project", "organization_id": "organization-001", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -9082,6 +9313,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "organization_id": "organization-001", "project_id": "project-001", "name": "Component Falcon", "description": "Description of the component", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -9119,6 +9351,7 @@ examples: fields: "id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "organization_id": "organization-001", "project_id": "project-001", "name": "Component Falcon", "description": "Description of the component", "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -9156,6 +9389,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "001", "name": "Task", "project_id": "project-001"}]} @@ -9192,6 +9426,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "001", "type": {"value": "to-do", "source_value": "New"}, "name": "Backlog"}]} @@ -9301,6 +9536,7 @@ examples: include: "all_parent_folder_ids" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": []} @@ -9338,6 +9574,7 @@ examples: include: "all_parent_folder_ids" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "description": "This is the description associated to the file.", "size": 1024, "url": "https://drive.google.com/file/d/nd8932h9d/view", "file_format": {"value": "pdf", "source_value": "application/pdf"}, "path": "/path/to/file", "owner_id": "c28xyrc55866bvuv", "export_formats": ["application/pdf"], "default_download_format": "application/pdf", "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "folder_id": "c28xyrc55866bvuv", "remote_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "drive_id": "c28xyrc55866bvuv", "remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z", "has_content": true, "has_children": true, "all_parent_folder_ids": ["0123456789"]}} @@ -9370,12 +9607,13 @@ examples: parameters: query: fields: "id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields" - filter: {"updated_after": "2020-01-01T00:00:00.000Z", "drive_id": "1234567890", "folder_id": "1234567890"} + filter: {"updated_after": "2020-01-01T00:00:00.000Z", "name": "Engineering", "drive_id": "1234567890", "folder_id": "1234567890"} folder_id: "1234567890" nested_items: "true" include: "all_parent_folder_ids" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "description": "This is the description associated to the folder.", "size": 1024, "url": "https://drive.google.com/folder/d/nd8932h9d/view", "path": "/path/to/folder", "owner_id": "c28xyrc55866bvuv", "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "parent_folder_id": "c28xyrc55866bvuv", "remote_parent_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "drive_id": "c28xyrc55866bvuv", "remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z", "has_content": true, "has_children": true, "is_root": true, "all_parent_folder_ids": ["0123456789"]}]} @@ -9413,6 +9651,7 @@ examples: include: "all_parent_folder_ids" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Information-Technology", "description": "This is the description associated to the folder.", "size": 1024, "url": "https://drive.google.com/folder/d/nd8932h9d/view", "path": "/path/to/folder", "owner_id": "c28xyrc55866bvuv", "remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "parent_folder_id": "c28xyrc55866bvuv", "remote_parent_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "drive_id": "c28xyrc55866bvuv", "remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z", "has_content": true, "has_children": true, "is_root": true, "all_parent_folder_ids": ["0123456789"]}} @@ -9448,6 +9687,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "USA Development Drive", "description": "Drive with USA Development documents", "url": "https://test.sharepoint.com/Document%20Library", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}]} @@ -9484,6 +9724,7 @@ examples: fields: "id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "16873-IT345", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "USA Development Drive", "description": "Drive with USA Development documents", "url": "https://test.sharepoint.com/Document%20Library", "created_at": "2023-02-23T00:00:00.000Z", "updated_at": "2024-02-23T00:00:00.000Z"}} @@ -9519,6 +9760,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Basic Background Check", "description": "Basic background check including identity verification and criminal records"}]} @@ -9555,6 +9797,7 @@ examples: fields: "id,remote_id,name,description,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "name": "Basic Background Check", "description": "Basic background check including identity verification and criminal records"}} @@ -9587,6 +9830,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"event": "screening.results.completed", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "order_id": "12345", "score": {"label": "Overall Risk", "value": "75", "min": "0", "max": "100"}, "start_date": "2023-01-01T00:00:00Z", "submission_date": "2023-01-02T00:00:00Z", "summary": "Background check completed successfully", "status": "completed", "result_url": "https://example.com/results/12345"}} responses: @@ -9621,6 +9865,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"passthrough": {"other_known_names": "John Doe"}, "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "package_id": "54321", "candidate": {"first_name": "John", "last_name": "Doe", "email": "john.doe@example.com"}} responses: @@ -9658,6 +9903,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "participants": ["c28xIQ1", "c28xIQ2"], "name": "Project Discussion", "private": true, "created_at": "2024-03-20T10:00:00Z", "last_message_at": "2024-03-20T11:30:00Z"}]} @@ -9690,6 +9936,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"participants": ["c28xIQ1", "c28xIQ2"], "name": "Project Discussion", "private": true} responses: @@ -9728,6 +9975,7 @@ examples: fields: "id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "participants": ["c28xIQ1", "c28xIQ2"], "name": "Project Discussion", "private": true, "created_at": "2024-03-20T10:00:00Z", "last_message_at": "2024-03-20T11:30:00Z"}} @@ -9803,6 +10051,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "file_name": "document.pdf", "file_size": 1024, "file_type": "application/pdf"}]} @@ -9840,6 +10089,7 @@ examples: fields: "id,remote_id,file_name,file_size,file_type,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "file_name": "document.pdf", "file_size": 1024, "file_type": "application/pdf"}} @@ -9875,6 +10125,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "email": "john.doe@example.com", "username": "johndoe", "name": "John Doe", "first_name": "John", "last_name": "Doe", "bot": false, "active": true}]} @@ -9911,6 +10162,7 @@ examples: fields: "id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "email": "john.doe@example.com", "username": "johndoe", "name": "John Doe", "first_name": "John", "last_name": "Doe", "bot": false, "active": true}} @@ -9948,6 +10200,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "content": {"html": "

Hello world

", "plain": "Hello world"}, "parent_message_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "author": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "external_reference": "al60043", "name": "John Dew", "email": "john@dew.com", "phone_number": "+1234567890", "active": true, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z"}]} @@ -9984,6 +10237,7 @@ examples: fields: "id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "content": {"html": "

Hello world

", "plain": "Hello world"}, "parent_message_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "attachments": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "file_name": "document.pdf", "file_size": 1024, "file_type": "application/pdf"}], "author": null, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z"}} @@ -10016,6 +10270,7 @@ examples: parameters: header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"content": "Hello, world!", "recipient": "c28xyrc55866bvuv", "sender": "+34820398402"} responses: @@ -10053,6 +10308,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "name": "Acme Corp", "base_currency": {"value": "USD", "source_value": "USD"}, "fiscal_year_start_month": 1, "fiscal_year_start_day": 1}]} @@ -10089,6 +10345,7 @@ examples: fields: "id,remote_id,name,base_currency,fiscal_year_start_month,fiscal_year_start_day,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": null} @@ -10126,6 +10383,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "company_id": "company_123", "code": "4000", "name": "Cash", "type": {"value": "asset", "source_value": "asset"}, "active": true}]} @@ -10163,6 +10421,7 @@ examples: fields: "id,remote_id,company_id,remote_company_id,code,name,type,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": null} @@ -10200,6 +10459,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "company_id": "company_123", "name": "VAT 7.5%", "code": "TAX001", "percentage": 7.5, "active": true}]} @@ -10237,6 +10497,7 @@ examples: fields: "id,remote_id,company_id,remote_company_id,name,code,percentage,active,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "company_id": "company_123", "name": "VAT 7.5%", "code": "TAX001", "percentage": 7.5, "active": true}} @@ -10271,6 +10532,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"items": []} responses: @@ -10310,6 +10572,7 @@ examples: filter: null header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "company_id": "comp_123456789", "reference": "JRN-2024-001", "memo": "Monthly closing entries", "transaction_date": "2024-03-20T10:00:00Z", "status": {"value": "draft", "source_value": "draft"}, "lines": [{"id": "line_1", "account_id": "acc_123", "description": "Payment for office supplies", "amount": 10010, "tax_amount": 2002}], "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z", "posted_at": "2024-03-20T10:00:00Z"}]} @@ -10344,6 +10607,7 @@ examples: id: "" header: x-account-id: "" + Prefer: "heartbeat" requestBody: application/json: {"reference": "JRN-2024-001", "memo": "Monthly closing entries", "currency_code": {"value": "USD", "source_value": "USD"}, "exchange_rate": 1, "transaction_date": "2024-03-20T10:00:00Z", "lines": [{"account_id": "acc_123456789", "description": "Payment for office supplies", "amount": 10010, "tax_rate_id": "tax_123456789", "tax_amount": 10010}]} responses: @@ -10385,6 +10649,7 @@ examples: fields: "id,remote_id,company_id,remote_company_id,reference,memo,transaction_date,status,lines,created_at,updated_at,posted_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "company_id": "comp_123456789", "reference": "JRN-2024-001", "memo": "Monthly closing entries", "transaction_date": "2024-03-20T10:00:00Z", "status": {"value": "draft", "source_value": "draft"}, "lines": [{"id": "line_1", "account_id": "acc_123", "description": "Payment for office supplies", "amount": 10010, "tax_amount": 2002}], "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z", "posted_at": "2024-03-20T10:00:00Z"}} @@ -10519,6 +10784,32 @@ examples: application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} "502": application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} + speakeasy-default-stackone-mcp-post: + requestBody: + application/json: {"jsonrpc": "2.0", "method": "initialize"} + responses: + "400": + application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": null, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} + "401": + application/json: {"statusCode": 401, "message": "Unauthorized", "timestamp": "2023-05-30T00:00:00.000Z"} + "403": + application/json: {"statusCode": 403, "message": "Forbidden resource", "timestamp": "2023-05-30T00:00:00.000Z"} + "404": + application/json: {"statusCode": 404, "message": "Not Found", "timestamp": "2023-05-30T00:00:00.000Z"} + "408": + application/json: {"statusCode": 408, "message": "Request timed out", "timestamp": "2023-05-30T00:00:00.000Z"} + "409": + application/json: {"statusCode": 409, "message": "Conflict", "timestamp": "2023-05-30T00:00:00.000Z"} + "422": + application/json: {"statusCode": 422, "message": "Unprocessable Entity", "timestamp": "2023-05-30T00:00:00.000Z"} + "429": + application/json: {"statusCode": 429, "message": "Too many requests", "timestamp": "2023-05-30T00:00:00.000Z"} + "500": + application/json: {"statusCode": 500, "message": "Internal server error", "timestamp": "2023-05-30T00:00:00.000Z"} + "501": + application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} + "502": + application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} stackone_mcp_delete: speakeasy-default-stackone-mcp-delete: parameters: @@ -10554,9 +10845,11 @@ examples: group_by: "[\"connector\"]" filter: {"connectors": "connector1,connector2", "account_ids": "account1,account2", "action_key": "action1"} include: ["action_details"] + search: "employee" + exclude: ["actions"] responses: "200": - application/json: {} + application/json: {"data": [{"categories": ["hris", "ats"]}]} "400": application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} "401": @@ -10581,8 +10874,11 @@ examples: application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} stackone_rpc_action: speakeasy-default-stackone-rpc-action: + parameters: + header: + x-account-id: "" requestBody: - application/json: {"action": "create_employee", "path": {"id": "123"}, "headers": {"Content-Type": "application/json"}, "body": {"data": "example"}} + application/json: {"action": "create_employee", "path": {"id": "123"}, "headers": {"Content-Type": "application/json"}, "body": {"data": "example"}, "defender_config": {"enabled": true, "block_high_risk": false, "use_tier1_classification": true, "use_tier2_classification": true}} responses: "200": application/json: {} @@ -10617,6 +10913,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z", "starts_after": "2024-01-15T09:00", "ends_before": "2024-01-15T17:00"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "emp_123456789", "location_id": "loc_123456789", "company_id": "comp_123456789", "start_time": "2024-03-20T09:00:00.000", "end_time": "2024-03-20T17:00:00.000", "break_duration": "PT1H30M", "status": {"value": "confirmed", "source_value": "Confirmed"}, "approval_status": {"value": "approved", "source_value": "Approved"}, "breaks": null, "created_at": "2024-03-20T08:00:00Z", "updated_at": "2024-03-20T08:00:00Z"}]} @@ -10652,6 +10949,7 @@ examples: subResourceId: "" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "employee_id": "emp_123456789", "location_id": "loc_123456789", "company_id": "comp_123456789", "start_time": "2024-03-20T09:00:00.000", "end_time": "2024-03-20T17:00:00.000", "break_duration": "PT1H30M", "status": {"value": "confirmed", "source_value": "Confirmed"}, "approval_status": null, "breaks": [{"id": "break_123456789", "start_time": "2024-03-20T12:00:00Z", "end_time": "2024-03-20T13:00:00Z", "duration": "PT1H", "is_paid": true, "created_at": "2024-03-20T10:00:00Z", "updated_at": "2024-03-20T10:00:00Z"}], "created_at": "2024-03-20T08:00:00Z", "updated_at": "2024-03-20T08:00:00Z"}} @@ -10687,6 +10985,7 @@ examples: filter: {"updated_after": "2020-01-01T00:00:00.000Z"} header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": [{"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}]} @@ -10723,6 +11022,7 @@ examples: fields: "id,remote_id,name,order,created_at,updated_at,unified_custom_fields" header: x-account-id: "" + Prefer: "heartbeat" responses: "200": application/json: {"data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "unified_custom_fields": {"my_project_custom_field_1": "REF-1236", "my_project_custom_field_2": "some other value"}, "created_at": "2021-01-01T01:01:01.000Z", "updated_at": "2021-01-01T01:01:01.000Z"}} @@ -10750,6 +11050,141 @@ examples: application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} "502": application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} + stackone_search_actions: + speakeasy-default-stackone-search-actions: + requestBody: + application/json: {"query": "send a message", "connector": "slack", "top_k": 100, "min_similarity": 0.4} + responses: + "200": + application/json: {"results": [{"action_id": "", "connector_key": "", "connector_version": "", "action_type": "", "similarity_score": 1341.06, "label": "", "description": "uh-huh amidst apud dreamily", "project_id": "", "input_schema": {}}], "total_count": 7184.27, "query": ""} + "400": + application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} + "401": + application/json: {"statusCode": 401, "message": "Unauthorized", "timestamp": "2023-05-30T00:00:00.000Z"} + "403": + application/json: {"statusCode": 403, "message": "Forbidden resource", "timestamp": "2023-05-30T00:00:00.000Z"} + "404": + application/json: {"statusCode": 404, "message": "Not Found", "timestamp": "2023-05-30T00:00:00.000Z"} + "408": + application/json: {"statusCode": 408, "message": "Request timed out", "timestamp": "2023-05-30T00:00:00.000Z"} + "409": + application/json: {"statusCode": 409, "message": "Conflict", "timestamp": "2023-05-30T00:00:00.000Z"} + "422": + application/json: {"statusCode": 422, "message": "Unprocessable Entity", "timestamp": "2023-05-30T00:00:00.000Z"} + "429": + application/json: {"statusCode": 429, "message": "Too many requests", "timestamp": "2023-05-30T00:00:00.000Z"} + "500": + application/json: {"statusCode": 500, "message": "Internal server error", "timestamp": "2023-05-30T00:00:00.000Z"} + "501": + application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} + "502": + application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} + stackone_build_action_embeddings: + speakeasy-default-stackone-build-action-embeddings: + requestBody: + application/json: {"connector_key": "slack", "force_refresh": false} + responses: + "200": + application/json: {"status": "accepted"} + "400": + application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} + "401": + application/json: {"statusCode": 401, "message": "Unauthorized", "timestamp": "2023-05-30T00:00:00.000Z"} + "403": + application/json: {"statusCode": 403, "message": "Forbidden resource", "timestamp": "2023-05-30T00:00:00.000Z"} + "404": + application/json: {"statusCode": 404, "message": "Not Found", "timestamp": "2023-05-30T00:00:00.000Z"} + "408": + application/json: {"statusCode": 408, "message": "Request timed out", "timestamp": "2023-05-30T00:00:00.000Z"} + "409": + application/json: {"statusCode": 409, "message": "Conflict", "timestamp": "2023-05-30T00:00:00.000Z"} + "422": + application/json: {"statusCode": 422, "message": "Unprocessable Entity", "timestamp": "2023-05-30T00:00:00.000Z"} + "429": + application/json: {"statusCode": 429, "message": "Too many requests", "timestamp": "2023-05-30T00:00:00.000Z"} + "500": + application/json: {"statusCode": 500, "message": "Internal server error", "timestamp": "2023-05-30T00:00:00.000Z"} + "501": + application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} + "502": + application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} + ats_create_interview_note: + speakeasy-default-ats-create-interview-note: + parameters: + path: + id: "" + header: + x-account-id: "" + Prefer: "heartbeat" + requestBody: + application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "visibility": {"value": "public", "source_value": "Public"}, "passthrough": {"other_known_names": "John Doe"}} + responses: + "201": + application/json: {"statusCode": 201, "message": "Record created successfully.", "timestamp": "2021-01-01T01:01:01.000Z", "data": {"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"}} + "400": + application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": null, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} + "401": + application/json: {"statusCode": 401, "message": "Unauthorized", "timestamp": "2023-05-30T00:00:00.000Z"} + "403": + application/json: {"statusCode": 403, "message": "Forbidden resource", "timestamp": "2023-05-30T00:00:00.000Z"} + "404": + application/json: {"statusCode": 404, "message": "Not Found", "timestamp": "2023-05-30T00:00:00.000Z"} + "408": + application/json: {"statusCode": 408, "message": "Request timed out", "timestamp": "2023-05-30T00:00:00.000Z"} + "409": + application/json: {"statusCode": 409, "message": "Conflict", "timestamp": "2023-05-30T00:00:00.000Z"} + "412": + application/json: {"statusCode": 412, "message": "Precondition failed", "timestamp": "2023-05-30T00:00:00.000Z"} + "422": + application/json: {"statusCode": 422, "message": "Unprocessable Entity", "timestamp": "2023-05-30T00:00:00.000Z"} + "429": + application/json: {"statusCode": 429, "message": "Too many requests", "timestamp": "2023-05-30T00:00:00.000Z"} + "500": + application/json: {"statusCode": 500, "message": "Internal server error", "timestamp": "2023-05-30T00:00:00.000Z"} + "501": + application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} + "502": + application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} + ats_update_interview_note: + speakeasy-default-ats-update-interview-note: + parameters: + path: + id: "" + subResourceId: "" + header: + x-account-id: "" + Prefer: "heartbeat" + requestBody: + application/json: {"content": [{"body": "This candidate seems like a good fit for the role"}], "author_id": "1234567890", "visibility": {"value": "public", "source_value": "Public"}, "passthrough": {"other_known_names": "John Doe"}} + responses: + "200": + application/json: {"statusCode": 200, "message": "Record updated successfully.", "timestamp": "2021-01-01T01:01:01.000Z"} + "400": + application/json: {"statusCode": 400, "message": "Bad Request", "timestamp": "2023-05-30T00:00:00.000Z", "data": {"statusCode": 400, "message": "Bad Request", "headers": {}}, "provider_errors": [{"status": 400, "url": "https://api.provider.com/v1/resource", "raw": {}, "headers": {}}]} + "401": + application/json: {"statusCode": 401, "message": "Unauthorized", "timestamp": "2023-05-30T00:00:00.000Z"} + "403": + application/json: {"statusCode": 403, "message": "Forbidden resource", "timestamp": "2023-05-30T00:00:00.000Z"} + "404": + application/json: {"statusCode": 404, "message": "Not Found", "timestamp": "2023-05-30T00:00:00.000Z"} + "408": + application/json: {"statusCode": 408, "message": "Request timed out", "timestamp": "2023-05-30T00:00:00.000Z"} + "409": + application/json: {"statusCode": 409, "message": "Conflict", "timestamp": "2023-05-30T00:00:00.000Z"} + "412": + application/json: {"statusCode": 412, "message": "Precondition failed", "timestamp": "2023-05-30T00:00:00.000Z"} + "422": + application/json: {"statusCode": 422, "message": "Unprocessable Entity", "timestamp": "2023-05-30T00:00:00.000Z"} + "429": + application/json: {"statusCode": 429, "message": "Too many requests", "timestamp": "2023-05-30T00:00:00.000Z"} + "500": + application/json: {"statusCode": 500, "message": "Internal server error", "timestamp": "2023-05-30T00:00:00.000Z"} + "501": + application/json: {"statusCode": 501, "message": "Not Implemented", "timestamp": "2023-05-30T00:00:00.000Z"} + "502": + application/json: {"statusCode": 502, "message": "Bad Gateway", "timestamp": "2023-05-30T00:00:00.000Z"} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## Postman SDK Changes Detected:\n* `StackOne.hris.get_employee_employment()`: `response.data.work_time` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_time_off_requests()`: \n * `request.filter` **Changed** **Breaking** :warning:\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `StackOne.Accounts.list_linked_accounts()`: `response.[].setup_information` **Changed** **Breaking** :warning:\n* `StackOne.Accounts.update_account()`: \n * `request.PatchAccountExternalDto.type` **Changed**\n * `response.setup_information` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_employees()`: `response.data.[]` **Changed** **Breaking** :warning:\n* `StackOne.accounting.create_company_journal()`: `response` **Changed** **Breaking** :warning:\n* `StackOne.messaging.get_message()`: `response.data.attachments.[]` **Changed** **Breaking** :warning:\n* `StackOne.messaging.list_conversation_messages()`: `response.data.[].attachments.[]` **Changed** **Breaking** :warning:\n* `StackOne.lms.create_user_completion()`: \n * `request.LmsCreateCompletionRequestDto.learning_object_external_reference` **Changed** **Breaking** :warning:\n* `StackOne.lms.update_content()`: \n * `request.LmsCreateContentRequestDto.external_reference` **Changed** **Breaking** :warning:\n* `StackOne.lms.upsert_content()`: \n * `request.LmsUpsertContentRequestDto.external_reference` **Changed** **Breaking** :warning:\n* `StackOne.lms.batch_upsert_content()`: \n * `request.LmsBatchUpsertContentRequestDto.items.[].external_reference` **Changed** **Breaking** :warning:\n* `StackOne.lms.create_user_assignment()`: \n * `request.LmsCreateAssignmentRequestDto.learning_object_external_reference` **Changed** **Breaking** :warning:\n* `StackOne.iam.get_user()`: `response.data.avatar.path` **Removed** **Breaking** :warning:\n* `StackOne.hris.create_employee()`: \n * `request.HrisCreateEmployeeRequestDto` **Changed** **Breaking** :warning:\n* `StackOne.hris.get_employee()`: `response.data` **Changed** **Breaking** :warning:\n* `StackOne.hris.update_employee()`: \n * `request.HrisUpdateEmployeeRequestDto` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_employee_time_off_requests()`: \n * `request.filter` **Changed** **Breaking** :warning:\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `StackOne.hris.get_employees_time_off_request()`: `response.data` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_employee_documents()`: `response.data.[].path` **Removed** **Breaking** :warning:\n* `StackOne.hris.get_employee_document()`: `response.data.path` **Removed** **Breaking** :warning:\n* `StackOne.hris.list_employee_work_eligibility()`: `response.data.[].document.path` **Removed** **Breaking** :warning:\n* `StackOne.hris.create_employee_work_eligibility_request()`: \n * `request.HrisCreateWorkEligibilityRequestDto.document.path` **Removed** **Breaking** :warning:\n* `StackOne.hris.get_employees_work_eligibility()`: `response.data.document.path` **Removed** **Breaking** :warning:\n* `StackOne.hris.update_employee_work_eligibility_request()`: \n * `request.HrisCreateWorkEligibilityRequestDto.document.path` **Removed** **Breaking** :warning:\n* `StackOne.iam.list_users()`: `response.data.[].avatar.path` **Removed** **Breaking** :warning:\n* `StackOne.ats.get_job_posting()`: `response.data.compensation.[]` **Changed** **Breaking** :warning:\n* `StackOne.ats.list_job_postings()`: `response.data.[].compensation.[]` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_employments()`: `response.data.[].work_time` **Changed** **Breaking** :warning:\n* `StackOne.hris.get_employment()`: `response.data.work_time` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_employee_employments()`: `response.data.[].work_time` **Changed** **Breaking** :warning:\n* `StackOne.hris.create_employee_employment()`: \n * `request.HrisCreateEmploymentRequestDto` **Changed** **Breaking** :warning:\n* `StackOne.Accounts.delete_account()`: `response.setup_information` **Changed** **Breaking** :warning:\n* `StackOne.Accounts.get_account()`: `response.setup_information` **Changed** **Breaking** :warning:\n* `StackOne.hris.get_employee_task()`: `response.data.attachments.[].path` **Removed** **Breaking** :warning:\n* `StackOne.hris.get_time_off_request()`: `response.data` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_shifts()`: \n * `request.filter` **Changed** **Breaking** :warning:\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `StackOne.hris.get_shift()`: `response.data` **Changed** **Breaking** :warning:\n* `StackOne.ats.get_application_document()`: `response.data.path` **Removed** **Breaking** :warning:\n* `StackOne.ats.list_application_documents()`: `response.data.[].path` **Removed** **Breaking** :warning:\n* `StackOne.hris.list_employee_tasks()`: `response.data.[].attachments.[].path` **Removed** **Breaking** :warning:\n* `StackOne.hris.update_employee_employment()`: \n * `request.HrisUpdateEmploymentRequestDto` **Changed** **Breaking** :warning:\n* `StackOne.hris.list_tasks()`: `response.data.[].attachments.[].path` **Removed** **Breaking** :warning:\n* `StackOne.hris.get_task()`: `response.data.attachments.[].path` **Removed** **Breaking** :warning:\n* `StackOne.ats.list_applications()`: \n * `request.filter` **Changed**\n * `response.data.[]` **Changed** **Breaking** :warning:\n* `StackOne.ats.get_application()`: `response.data` **Changed** **Breaking** :warning:\n* `StackOne.lms.list_user_assignments()`: \n * `request.filter` **Changed**\n* `StackOne.hris.list_time_off_policies()`: \n * `request.filter` **Changed**\n* `StackOne.ats.list_candidates()`: `response.data.[].tags` **Added**\n* `StackOne.ats.get_candidate()`: `response.data.tags` **Added**\n* `StackOne.ats.list_interview_stages()`: **Deprecated**\n* `StackOne.ats.get_interview_stage()`: **Deprecated**\n* `StackOne.hris.get_employee_time_off_balance()`: `response.data.is_unlimited` **Added**\n* `StackOne.hris.list_employee_time_off_balances()`: `response.data.[].is_unlimited` **Added**\n* `StackOne.hris.list_employee_time_off_policies()`: \n * `request.filter` **Changed**\n* `StackOne.Proxy.proxy_request()`: `response` **Changed**\n* `StackOne.hris.get_employee_shift()`: **Added**\n* `StackOne.ats.get_application_stage()`: **Added**\n* `StackOne.ats.list_application_stages()`: **Added**\n* `StackOne.hris.list_employee_shifts()`: **Added**\n* `StackOne.Actions.rpc_action()`: **Added**\n* `StackOne.Actions.list_actions_meta()`: **Added**\n* `StackOne.lms.list_assignments()`: \n * `request.filter` **Changed**\n* `StackOne.MCP.mcp_delete()`: **Added**\n* `StackOne.MCP.mcp_post()`: **Added**\n* `StackOne.MCP.mcp_get()`: **Added**\n" +releaseNotes: "## Postman SDK Changes:\n* `StackOne.Connectors.get_connector_meta()`: `response.category.enum(scheduling)` **Added** (Breaking ⚠️)\n* `StackOne.lms.create_user_assignment()`: `request` **Changed** (Breaking ⚠️)\n* `StackOne.ats.get_job_posting()`: \n * `request.Prefer` **Added**\n * `response.data` **Changed** (Breaking ⚠️)\n* `StackOne.ats.list_job_postings()`: \n * `request.Prefer` **Added**\n * `response.data[]` **Changed** (Breaking ⚠️)\n* `StackOne.hris.get_position()`: \n * `request.Prefer` **Added**\n * `response.data.status.value.enum(draft)` **Added** (Breaking ⚠️)\n* `StackOne.Connect Sessions.create_connect_session()`: \n * `request` **Changed**\n * `response` **Changed** (Breaking ⚠️)\n* `StackOne.Connect Sessions.authenticate_connect_session()`: `response` **Changed** (Breaking ⚠️)\n* `StackOne.Accounts.list_linked_accounts()`: `response.[]` **Changed** (Breaking ⚠️)\n* `StackOne.Accounts.get_account()`: `response` **Changed** (Breaking ⚠️)\n* `StackOne.Accounts.delete_account()`: `response` **Changed** (Breaking ⚠️)\n* `StackOne.Accounts.update_account()`: \n * `request.PatchAccountExternalDto` **Changed**\n * `response` **Changed** (Breaking ⚠️)\n* `StackOne.hris.list_positions()`: \n * `request` **Changed**\n * `response.data[].status.value.enum(draft)` **Added** (Breaking ⚠️)\n* `StackOne.Accounts.get_account_meta_info()`: `response.category.enum(scheduling)` **Added** (Breaking ⚠️)\n* `StackOne.Actions.rpc_action()`: `request` **Changed** (Breaking ⚠️)\n* `StackOne.Connectors.list_connectors_meta()`: `response.[].category.enum(scheduling)` **Added** (Breaking ⚠️)\n* `StackOne.Actions.list_actions_meta()`: \n * `request` **Changed** (Breaking ⚠️)\n * `response.data[]` **Changed** (Breaking ⚠️)\n* `StackOne.ats.get_list()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_skills()`: \n * `request.Prefer` **Added**\n* `StackOne.Proxy.proxy_request()`: **Deprecated**\n* `StackOne.Proxy.proxy_request()`: \n * `request.Prefer` **Added**\n* `StackOne.Connectors.get_connector_meta()`: **Deprecated**\n* `StackOne.Connectors.list_connectors_meta()`: **Deprecated**\n* `StackOne.hris.list_companies()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_company()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_custom_field_definitions()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_custom_field_definition()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employees()`: \n * `request.Prefer` **Added**\n * `response.data[].employments[].manager[]` **Changed**\n* `StackOne.hris.create_employee()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee()`: \n * `request.Prefer` **Added**\n * `response.data.employments[].manager[]` **Changed**\n* `StackOne.hris.update_employee()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.invite_employee()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_shifts()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_shift()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_time_off_requests()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.create_employee_time_off_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employees_time_off_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.cancel_employee_time_off_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.update_employee_time_off_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_documents()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_document()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_categories()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_document_category()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_work_eligibility()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.create_employee_work_eligibility_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employees_work_eligibility()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.update_employee_work_eligibility_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_time_off_balances()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_time_off_balance()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employments()`: \n * `request.Prefer` **Added**\n * `response.data[].manager[]` **Changed**\n* `StackOne.hris.get_employment()`: \n * `request.Prefer` **Added**\n * `response.data.manager[]` **Changed**\n* `StackOne.hris.list_employee_employments()`: \n * `request.Prefer` **Added**\n * `response.data[].manager[]` **Changed**\n* `StackOne.hris.create_employee_employment()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_employment()`: \n * `request.Prefer` **Added**\n * `response.data.manager[]` **Changed**\n* `StackOne.hris.update_employee_employment()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_department_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_cost_center_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_team_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_division_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_companies_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_department_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_cost_center_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_team_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_division_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_company_group()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_jobs()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_job()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_locations()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_location()`: \n * `request.Prefer` **Added**\n* `StackOne.Accounts.get_account_meta_info()`: **Deprecated**\n* `StackOne.lms.update_content()`: **Removed** (Breaking ⚠️)\n* `StackOne.hris.list_time_entries()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_time_entries()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_time_off_requests()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_time_off_request()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_shifts()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_shift()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_time_off_types()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_time_off_type()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_time_off_policies()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_time_off_policy()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_time_off_policies()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_interview_note()`: **Added**\n* `StackOne.hris.get_benefit()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_offers()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.create_employee_skill()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.get_employee_skill()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_employee_tasks()`: `request` **Changed**\n* `StackOne.hris.get_employee_task()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.update_employee_task()`: \n * `request.Prefer` **Added**\n* `StackOne.hris.list_tasks()`: `request` **Changed**\n* `StackOne.hris.get_task()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_applications()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_application()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_application()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_applications_offers()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.move_application()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.reject_application()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_offer()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_scorecards()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_scorecard()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_changes()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_notes()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_application_note()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_note()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_application_note()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_applications_scheduled_interviews()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_scheduled_interview()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_documents()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_document()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_candidates()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_candidate()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_candidate()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_candidate()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_candidate_notes()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_candidate_note()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_candidate_note()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_custom_field_definitions()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_custom_field_definition()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_candidate_custom_field_definitions()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_candidate_custom_field_definition()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_offer()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_job_custom_field_definition()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_departments()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_department()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_interview_stages()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_interview_stage()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_stages()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_stage()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_interviews()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_interview()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_jobs()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_job()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_job_application_stages()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_job()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_job()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_job_application_stage()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_lists()`: \n * `request.Prefer` **Added**\n* `StackOne.Actions.search_actions()`: **Added**\n* `StackOne.ats.list_locations()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_location()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_rejected_reasons()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_rejected_reason()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_users()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_user()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_interview_note()`: **Added**\n* `StackOne.hris.list_benefits()`: \n * `request.Prefer` **Added**\n* `StackOne.MCP.mcp_post()`: `request` **Changed**\n* `StackOne.ats.list_job_custom_field_definitions()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_offer()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_assessments_packages()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_assessments_package()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.order_assessments_request()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_assessments_result()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_background_check_packages()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.create_background_check_package()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_background_check_package()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.delete_background_check_package()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_background_check_package()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.order_background_check_request()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.update_background_check_result()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.list_application_document_categories()`: \n * `request.Prefer` **Added**\n* `StackOne.ats.get_application_document_category()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.list_contacts()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.create_contact()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.get_contact()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.update_contact()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.list_accounts()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.get_account()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.list_lists()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.get_list()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.list_contact_custom_field_definitions()`: \n * `request.Prefer` **Added**\n* `StackOne.crm.get_contact_custom_field_definition()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.list_users()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.get_user()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.delete_user()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.update_user()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.list_roles()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.get_role()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.list_groups()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.get_group()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.list_policies()`: \n * `request.Prefer` **Added**\n* `StackOne.iam.get_policy()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_email_templates()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_email_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_email_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_email_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_in_app_templates()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_in_app_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_in_app_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_in_app_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_sms_templates()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_sms_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_sms_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_sms_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_omni_channel_templates()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_omni_channel_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_omni_channel_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_omni_channel_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_push_templates()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_push_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_push_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_push_template()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_campaigns()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_campaign()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.list_content_blocks()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.create_content_block()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.get_content_block()`: \n * `request.Prefer` **Added**\n* `StackOne.marketing.update_content_block()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_courses()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.get_course()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_user_assignments()`: \n * `request.Prefer` **Added**\n * `response.data[].assigned_at` **Added**\n* `StackOne.Actions.build_action_embeddings()`: **Added**\n* `StackOne.lms.get_user_assignment()`: \n * `request.Prefer` **Added**\n * `response.data.assigned_at` **Added**\n* `StackOne.lms.batch_upsert_content()`: `request` **Changed**\n* `StackOne.lms.list_content()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.upsert_content()`: `request` **Changed**\n* `StackOne.lms.get_content()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_user_completions()`: \n * `request.Prefer` **Added**\n * `response.data[].score` **Added**\n* `StackOne.lms.create_user_completion()`: `request` **Changed**\n* `StackOne.lms.get_user_completion()`: \n * `request.Prefer` **Added**\n * `response.data.score` **Added**\n* `StackOne.lms.delete_user_completion()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_completions()`: \n * `request.Prefer` **Added**\n * `response.data[].score` **Added**\n* `StackOne.lms.get_completion()`: \n * `request.Prefer` **Added**\n * `response.data.score` **Added**\n* `StackOne.lms.get_category()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_categories()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_users()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.get_user()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.get_skill()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_skills()`: \n * `request.Prefer` **Added**\n* `StackOne.lms.list_assignments()`: \n * `request.Prefer` **Added**\n * `response.data[].assigned_at` **Added**\n* `StackOne.lms.get_assignment()`: \n * `request.Prefer` **Added**\n * `response.data.assigned_at` **Added**\n* `StackOne.ticketing.list_tickets()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.create_ticket()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_ticket()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.update_ticket()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_users()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_user()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_comments()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_comment()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_attachments()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_attachment()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_ticket_types()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_ticket_type()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_projects()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_project()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_project_components()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.get_project_component()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_project_ticket_types()`: \n * `request.Prefer` **Added**\n* `StackOne.ticketing.list_ticket_statuses()`: \n * `request.Prefer` **Added**\n* `StackOne.documents.list_files()`: \n * `request.Prefer` **Added**\n* `StackOne.documents.get_file()`: \n * `request.Prefer` **Added**\n* `StackOne.documents.list_folders()`: `request` **Changed**\n* `StackOne.documents.get_folder()`: \n * `request.Prefer` **Added**\n* `StackOne.documents.list_drives()`: \n * `request.Prefer` **Added**\n* `StackOne.documents.get_drive()`: \n * `request.Prefer` **Added**\n* `StackOne.screening.list_screening_packages()`: \n * `request.Prefer` **Added**\n* `StackOne.screening.get_screening_package()`: \n * `request.Prefer` **Added**\n* `StackOne.screening.webhook_screening_result()`: \n * `request.Prefer` **Added**\n* `StackOne.screening.create_screening_order()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.list_conversations()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.create_conversation()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.get_conversation()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.list_attachments()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.get_attachment()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.list_users()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.get_user()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.list_conversation_messages()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.get_message()`: \n * `request.Prefer` **Added**\n* `StackOne.messaging.send_message()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.list_companies()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.get_company()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.list_company_accounts()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.get_company_account()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.list_company_tax_rates()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.get_company_tax_rate()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.batch_create_company_journals()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.list_company_journals()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.create_company_journal()`: \n * `request.Prefer` **Added**\n* `StackOne.accounting.get_company_journal()`: \n * `request.Prefer` **Added**\n" +generatedFiles: + - StackOne_postman_collection.json diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 833940a..6d13745 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,6 +13,8 @@ generation: requestResponseComponentNamesFeb2024: true securityFeb2025: false sharedErrorComponentsApr2025: false + sharedNestedComponentsJan2026: false + nameOverrideFeb2026: false auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false @@ -20,12 +22,14 @@ generation: schemas: allOfMergeStrategy: shallowMerge requestBodyFieldName: "" + versioningStrategy: automatic + persistentEdits: {} tests: generateTests: true generateNewTests: false skipResponseBodyAssertions: false postman: - version: 0.3.0 + version: 0.3.1 baseErrorName: StackOneError defaultErrorName: StackOneDefaultError imports: @@ -35,6 +39,7 @@ postman: errors: errors operations: operations shared: shared + inferUnionDiscriminators: false inputModelSuffix: input outputModelSuffix: output packageName: StackOne diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 994c353..651ccdb 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.653.0 +speakeasyVersion: 1.759.3 sources: hris: sourceNamespace: hris @@ -8,18 +8,17 @@ sources: - latest my-source: sourceNamespace: my-source - sourceRevisionDigest: sha256:1974e692f70462cc257a0a25a49638c4a2c28cf225b751c2877caf9ba5eea273 - sourceBlobDigest: sha256:d50cf5ce138486b86d7c5837c8a209775b17f7c890552dfc83bdaff8fb6ac793 + sourceRevisionDigest: sha256:eb9f5a57ee0f6f03f9cf6ef29c610c5c1bf132667dda67a04a5507689d169352 + sourceBlobDigest: sha256:8fd2560dd3b7b8e575f7b3539c526222975bce4368b8215a2d81a55cba5ff008 tags: - latest - - speakeasy-sdk-regen-1757376930 - 1.0.0 targets: my-first-target: source: my-source sourceNamespace: my-source - sourceRevisionDigest: sha256:1974e692f70462cc257a0a25a49638c4a2c28cf225b751c2877caf9ba5eea273 - sourceBlobDigest: sha256:d50cf5ce138486b86d7c5837c8a209775b17f7c890552dfc83bdaff8fb6ac793 + sourceRevisionDigest: sha256:eb9f5a57ee0f6f03f9cf6ef29c610c5c1bf132667dda67a04a5507689d169352 + sourceBlobDigest: sha256:8fd2560dd3b7b8e575f7b3539c526222975bce4368b8215a2d81a55cba5ff008 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 429ca90..634f23c 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -126,4 +126,12 @@ Based on: - OpenAPI Doc - Speakeasy CLI 1.653.0 (2.748.0) https://github.com/speakeasy-api/speakeasy ### Generated -- [postman v0.3.0] . \ No newline at end of file +- [postman v0.3.0] . + +## 2026-03-28 00:24:01 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.759.3 (2.869.25) https://github.com/speakeasy-api/speakeasy +### Generated +- [postman v0.3.1] . \ No newline at end of file diff --git a/StackOne_postman_collection.json b/StackOne_postman_collection.json index 4392a07..0590197 100644 --- a/StackOne_postman_collection.json +++ b/StackOne_postman_collection.json @@ -1,7 +1,22 @@ { + "auth": { + "type": "http", + "http": [ + { + "key": "password", + "value": "{{password}}", + "type": "string" + }, + { + "key": "username", + "value": "{{username}}", + "type": "string" + } + ] + }, "info": { "name": "StackOne", - "description": "Accounting: The documentation for the StackOne Unified API - ACCOUNTING", + "description": "Accounting: The documentation for the StackOne API\nThe documentation for the StackOne Unified API - HRIS\nThe documentation for the StackOne Unified API - ATS\nThe documentation for the StackOne Unified API - CRM\nThe documentation for the StackOne Unified API - IAM\nThe documentation for the StackOne Unified API - MARKETING\nThe documentation for the StackOne Unified API - LMS\nThe documentation for the StackOne Unified API - TICKETING\nThe documentation for the StackOne Unified API - DOCUMENTS\nThe documentation for the StackOne Unified API - SCREENING\nThe documentation for the StackOne Unified API - MESSAGING\nThe documentation for the StackOne Unified API - ACCOUNTING", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ @@ -257,7 +272,7 @@ } }, { - "name": "Get Account Meta Information", + "name": "Get Account Meta Information (Legacy)", "request": { "method": "GET", "header": [ @@ -499,7 +514,7 @@ "name": "Connectors", "item": [ { - "name": "List Connector Meta Information", + "name": "List Connector Meta Information (Legacy)", "request": { "method": "GET", "header": [ @@ -530,7 +545,7 @@ } }, { - "name": "Get Connector Meta Information", + "name": "Get Connector Meta Information (Legacy)", "request": { "method": "GET", "header": [ @@ -577,6 +592,21 @@ { "name": "Open MCP SSE stream", "request": { + "auth": { + "type": "http", + "http": [ + { + "key": "password", + "value": "{{password}}", + "type": "string" + }, + { + "key": "username", + "value": "{{username}}", + "type": "string" + } + ] + }, "method": "GET", "header": [ { @@ -617,6 +647,21 @@ { "name": "Send MCP JSON-RPC message", "request": { + "auth": { + "type": "http", + "http": [ + { + "key": "password", + "value": "{{password}}", + "type": "string" + }, + { + "key": "username", + "value": "{{username}}", + "type": "string" + } + ] + }, "method": "POST", "header": [ { @@ -653,6 +698,11 @@ "mcp" ], "query": [ + { + "key": "tool-mode", + "value": "search_execute", + "type": "enum" + }, { "key": "x-account-idQueryParameter", "value": "", @@ -666,6 +716,21 @@ { "name": "Delete MCP session", "request": { + "auth": { + "type": "http", + "http": [ + { + "key": "password", + "value": "{{password}}", + "type": "string" + }, + { + "key": "username", + "value": "{{username}}", + "type": "string" + } + ] + }, "method": "DELETE", "header": [ { @@ -706,50 +771,6 @@ ], "description": "Model Context Protocol endpoint." }, - { - "name": "Proxy", - "item": [ - { - "name": "Proxy Request", - "request": { - "method": "POST", - "header": [ - { - "key": "x-account-id", - "value": "", - "type": "string" - }, - { - "key": "Content-Type", - "value": "application/json", - "type": "string" - }, - { - "key": "Accept", - "value": "application/json", - "type": "string" - } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "url": { - "raw": "{{baseUrl}}/unified/proxy", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "unified", - "proxy" - ] - }, - "description": "" - } - } - ], - "description": "Routing API requests through StackOne directly to the underlying provider." - }, { "name": "Actions", "item": [ @@ -773,11 +794,6 @@ "actions" ], "query": [ - { - "key": "page", - "value": "", - "type": "string" - }, { "key": "page_size", "value": "", @@ -803,7 +819,20 @@ { "key": "include", "value": [ - "action_details" + "action_details", + "authentication_guides" + ], + "type": "array" + }, + { + "key": "search", + "value": "employee", + "type": "string" + }, + { + "key": "exclude", + "value": [ + "actions" ], "type": "array" } @@ -812,11 +841,82 @@ "description": "Retrieves a list of all actions metadata" } }, + { + "name": "Search connector actions by semantic similarity", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, + { + "key": "Accept", + "value": "application/json", + "type": "string" + } + ], + "body": { + "mode": "raw", + "raw": "{}" + }, + "url": { + "raw": "{{baseUrl}}/actions/search", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "actions", + "search" + ] + }, + "description": "" + } + }, + { + "name": "Rebuild action embeddings for semantic search", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, + { + "key": "Accept", + "value": "application/json", + "type": "string" + } + ], + "body": { + "mode": "raw", + "raw": "{}" + }, + "url": { + "raw": "{{baseUrl}}/actions/build", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "actions", + "build" + ] + }, + "description": "" + } + }, { "name": "Make an RPC call to an action", "request": { "method": "POST", "header": [ + { + "key": "x-account-id", + "value": "", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -848,6 +948,55 @@ ], "description": "Retrieve Actions metadata and definitions." }, + { + "name": "Proxy", + "item": [ + { + "name": "Proxy Request (Legacy)", + "request": { + "method": "POST", + "header": [ + { + "key": "x-account-id", + "value": "", + "type": "string" + }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, + { + "key": "Accept", + "value": "application/json", + "type": "string" + } + ], + "body": { + "mode": "raw", + "raw": "{}" + }, + "url": { + "raw": "{{baseUrl}}/unified/proxy", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "unified", + "proxy" + ] + }, + "description": "" + } + } + ], + "description": "Routing API requests through StackOne directly to the underlying provider." + }, { "name": "hris", "item": [ @@ -861,6 +1010,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -915,7 +1069,7 @@ }, { "key": "updated_after", - "value": "2024-09-14T13:50:38.886Z", + "value": "2026-10-11T10:53:38.306Z", "type": "date-time" } ] @@ -933,6 +1087,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -953,7 +1112,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -988,6 +1147,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1043,7 +1207,7 @@ }, { "key": "updated_after", - "value": "2023-04-06T11:50:56.757Z", + "value": "2024-01-23T03:49:29.014Z", "type": "date-time" } ] @@ -1061,6 +1225,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1082,7 +1251,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -1117,7 +1286,7 @@ }, { "key": "updated_after", - "value": "2025-07-01T13:13:56.703Z", + "value": "2026-05-02T20:38:06.637Z", "type": "date-time" } ], @@ -1142,6 +1311,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1196,7 +1370,7 @@ }, { "key": "updated_after", - "value": "2025-08-11T12:47:58.371Z", + "value": "2026-12-08T13:34:36.747Z", "type": "date-time" }, { @@ -1224,6 +1398,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -1263,6 +1442,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1328,6 +1512,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -1375,6 +1564,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -1423,6 +1617,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1444,7 +1643,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -1479,7 +1678,7 @@ }, { "key": "updated_after", - "value": "2024-05-20T18:45:11.321Z", + "value": "2026-05-05T11:02:22.031Z", "type": "date-time" } ], @@ -1504,6 +1703,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1526,7 +1730,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -1566,6 +1770,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1587,7 +1796,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -1622,7 +1831,7 @@ }, { "key": "updated_after", - "value": "2024-12-02T08:28:57.162Z", + "value": "2024-06-06T02:45:53.539Z", "type": "date-time" }, { @@ -1652,6 +1861,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -1700,6 +1914,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -1722,7 +1941,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -1758,21 +1977,35 @@ } }, { - "name": "Cancel Employee Time Off Request", + "name": "Update Employee Time Off Request", "request": { - "method": "DELETE", + "method": "PATCH", "header": [ { "key": "x-account-id", "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, { "key": "Accept", "value": "application/json", "type": "string" } ], + "body": { + "mode": "raw", + "raw": "{}" + }, "url": { "raw": "{{baseUrl}}/unified/hris/employees/{id}/time_off/{subResourceId}", "host": [ @@ -1803,9 +2036,9 @@ } }, { - "name": "Update Employee Time Off Request", + "name": "Cancel Employee Time Off Request", "request": { - "method": "PATCH", + "method": "DELETE", "header": [ { "key": "x-account-id", @@ -1813,8 +2046,8 @@ "type": "string" }, { - "key": "Content-Type", - "value": "application/json", + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -1823,10 +2056,6 @@ "type": "string" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, "url": { "raw": "{{baseUrl}}/unified/hris/employees/{id}/time_off/{subResourceId}", "host": [ @@ -2023,6 +2252,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2079,7 +2313,7 @@ }, { "key": "updated_after", - "value": "2024-07-25T22:41:53.719Z", + "value": "2025-03-30T11:16:03.610Z", "type": "date-time" } ], @@ -2104,6 +2338,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2166,6 +2405,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2186,7 +2430,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -2221,7 +2465,7 @@ }, { "key": "updated_after", - "value": "2025-04-28T13:26:34.681Z", + "value": "2025-05-14T22:34:42.019Z", "type": "date-time" } ] @@ -2239,6 +2483,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2260,7 +2509,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -2295,6 +2544,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2316,7 +2570,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -2351,7 +2605,7 @@ }, { "key": "updated_after", - "value": "2023-01-21T14:14:48.878Z", + "value": "2025-11-07T22:17:02.814Z", "type": "date-time" } ], @@ -2376,6 +2630,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -2424,6 +2683,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2486,6 +2750,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -2540,6 +2809,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2596,7 +2870,7 @@ }, { "key": "updated_after", - "value": "2024-11-07T03:49:54.674Z", + "value": "2026-10-31T08:20:58.047Z", "type": "date-time" }, { @@ -2626,6 +2900,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2693,6 +2972,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2712,7 +2996,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -2747,7 +3031,7 @@ }, { "key": "updated_after", - "value": "2024-01-30T00:29:44.940Z", + "value": "2025-04-23T23:41:18.646Z", "type": "date-time" }, { @@ -2770,6 +3054,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2790,7 +3079,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -2830,6 +3119,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -2851,7 +3145,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -2886,7 +3180,7 @@ }, { "key": "updated_after", - "value": "2023-03-08T00:10:14.900Z", + "value": "2025-12-31T18:37:54.059Z", "type": "date-time" }, { @@ -2916,6 +3210,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -2964,6 +3263,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3031,6 +3335,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -3085,6 +3394,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3104,7 +3418,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -3139,7 +3453,7 @@ }, { "key": "updated_after", - "value": "2023-08-19T13:54:10.391Z", + "value": "2024-05-21T07:16:38.400Z", "type": "date-time" } ] @@ -3157,6 +3471,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3212,7 +3531,7 @@ }, { "key": "updated_after", - "value": "2023-12-12T17:01:38.434Z", + "value": "2025-02-02T15:02:53.228Z", "type": "date-time" } ] @@ -3230,6 +3549,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3250,7 +3574,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -3285,7 +3609,7 @@ }, { "key": "updated_after", - "value": "2024-09-16T22:27:21.057Z", + "value": "2025-04-25T16:58:27.156Z", "type": "date-time" } ] @@ -3303,6 +3627,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3323,7 +3652,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -3358,7 +3687,7 @@ }, { "key": "updated_after", - "value": "2025-12-19T06:11:07.571Z", + "value": "2024-04-21T20:11:12.127Z", "type": "date-time" } ] @@ -3376,6 +3705,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3431,7 +3765,7 @@ }, { "key": "updated_after", - "value": "2023-08-17T22:17:39.092Z", + "value": "2024-06-25T19:05:08.010Z", "type": "date-time" } ] @@ -3449,6 +3783,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3469,7 +3808,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -3504,7 +3843,7 @@ }, { "key": "updated_after", - "value": "2024-12-16T19:21:41.015Z", + "value": "2024-10-04T14:34:56.327Z", "type": "date-time" } ] @@ -3522,6 +3861,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3577,6 +3921,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3633,6 +3982,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3689,6 +4043,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3745,6 +4104,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3766,7 +4130,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -3801,6 +4165,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3822,7 +4191,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -3857,6 +4226,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3911,7 +4285,7 @@ }, { "key": "updated_after", - "value": "2023-08-04T10:54:08.790Z", + "value": "2025-02-08T02:56:48.801Z", "type": "date-time" } ] @@ -3929,6 +4303,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -3949,7 +4328,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -3984,6 +4363,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4003,7 +4387,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -4038,7 +4422,7 @@ }, { "key": "updated_after", - "value": "2023-04-17T10:09:07.050Z", + "value": "2026-07-07T09:18:10.249Z", "type": "date-time" } ] @@ -4056,6 +4440,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4076,7 +4465,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -4111,6 +4500,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4130,7 +4524,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -4165,12 +4559,12 @@ }, { "key": "updated_after", - "value": "2025-12-06T04:47:23.164Z", + "value": "2025-05-28T15:24:04.349Z", "type": "date-time" }, { "key": "status", - "value": "closed", + "value": "unmapped_value", "type": "enum" } ] @@ -4188,6 +4582,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4243,6 +4642,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4297,7 +4701,7 @@ }, { "key": "updated_after", - "value": "2025-03-21T05:35:21.093Z", + "value": "2024-02-12T22:47:44.474Z", "type": "date-time" } ] @@ -4315,6 +4719,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4370,6 +4779,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4424,7 +4838,7 @@ }, { "key": "updated_after", - "value": "2023-05-12T17:39:01.246Z", + "value": "2024-11-20T13:40:18.320Z", "type": "date-time" }, { @@ -4447,6 +4861,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4507,6 +4926,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4561,7 +4985,7 @@ }, { "key": "updated_after", - "value": "2023-12-15T12:13:46.383Z", + "value": "2025-03-30T00:46:25.708Z", "type": "date-time" } ] @@ -4579,6 +5003,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4634,6 +5063,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4653,7 +5087,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -4688,7 +5122,7 @@ }, { "key": "updated_after", - "value": "2025-01-28T22:47:11.861Z", + "value": "2025-09-12T23:53:04.745Z", "type": "date-time" } ] @@ -4706,6 +5140,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4726,7 +5165,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -4761,6 +5200,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4780,7 +5224,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -4815,7 +5259,7 @@ }, { "key": "updated_after", - "value": "2024-07-27T11:31:00.474Z", + "value": "2024-04-12T23:00:40.302Z", "type": "date-time" } ] @@ -4833,6 +5277,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4853,7 +5302,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -4888,6 +5337,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4944,7 +5398,7 @@ }, { "key": "updated_after", - "value": "2025-10-15T12:12:25.852Z", + "value": "2024-12-15T03:38:15.811Z", "type": "date-time" } ], @@ -4969,6 +5423,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -4988,7 +5447,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5023,7 +5482,7 @@ }, { "key": "updated_after", - "value": "2025-01-01T11:33:45.485Z", + "value": "2024-05-24T10:48:39.501Z", "type": "date-time" } ] @@ -5041,6 +5500,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5061,7 +5525,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5096,6 +5560,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5117,7 +5586,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -5152,7 +5621,7 @@ }, { "key": "updated_after", - "value": "2023-11-14T04:32:16.328Z", + "value": "2024-07-19T18:39:56.110Z", "type": "date-time" } ], @@ -5177,6 +5646,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -5225,6 +5699,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5247,7 +5726,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5287,6 +5766,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5308,7 +5792,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -5343,7 +5827,7 @@ }, { "key": "updated_after", - "value": "2023-01-23T00:54:32.021Z", + "value": "2026-06-27T12:26:18.703Z", "type": "date-time" }, { @@ -5373,6 +5857,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5395,7 +5884,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -5440,6 +5929,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -5494,6 +5988,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5513,7 +6012,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5548,7 +6047,7 @@ }, { "key": "updated_after", - "value": "2025-01-12T21:17:10.262Z", + "value": "2024-10-22T22:17:23.016Z", "type": "date-time" }, { @@ -5571,6 +6070,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5591,7 +6095,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5636,6 +6140,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5690,7 +6199,7 @@ }, { "key": "updated_after", - "value": "2025-11-20T13:24:26.967Z", + "value": "2024-09-29T15:12:09.673Z", "type": "date-time" }, { @@ -5724,8 +6233,13 @@ "method": "POST", "header": [ { - "key": "x-account-id", - "value": "", + "key": "x-account-id", + "value": "", + "type": "string" + }, + { + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -5767,6 +6281,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5787,7 +6306,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -5832,6 +6351,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -5879,6 +6403,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -5935,7 +6464,7 @@ }, { "key": "updated_after", - "value": "2024-10-10T21:04:15.457Z", + "value": "2025-09-19T04:30:50.868Z", "type": "date-time" }, { @@ -5965,6 +6494,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -6013,6 +6547,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -6061,6 +6600,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6083,7 +6627,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -6123,6 +6667,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6144,7 +6693,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -6179,7 +6728,7 @@ }, { "key": "updated_after", - "value": "2025-11-10T05:06:35.997Z", + "value": "2025-05-05T01:11:09.453Z", "type": "date-time" }, { @@ -6209,6 +6758,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6231,7 +6785,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -6271,6 +6825,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6342,6 +6901,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6363,7 +6927,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -6398,7 +6962,7 @@ }, { "key": "updated_after", - "value": "2023-11-22T23:46:53.599Z", + "value": "2026-06-10T22:08:16.258Z", "type": "date-time" }, { @@ -6428,6 +6992,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -6476,6 +7045,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6498,7 +7072,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -6538,6 +7112,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -6592,6 +7171,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6613,7 +7197,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -6648,7 +7232,7 @@ }, { "key": "updated_after", - "value": "2025-08-23T16:32:18.589Z", + "value": "2025-09-29T01:48:05.911Z", "type": "date-time" }, { @@ -6678,6 +7262,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6847,6 +7436,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6903,7 +7497,7 @@ }, { "key": "updated_after", - "value": "2025-01-29T00:21:03.404Z", + "value": "2026-03-05T21:05:18.875Z", "type": "date-time" }, { @@ -6933,6 +7527,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -6995,6 +7594,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7049,7 +7653,7 @@ }, { "key": "updated_after", - "value": "2025-11-13T20:49:26.140Z", + "value": "2025-12-06T19:31:05.522Z", "type": "date-time" }, { @@ -7077,6 +7681,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -7116,6 +7725,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7136,7 +7750,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -7176,6 +7790,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -7223,6 +7842,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7244,7 +7868,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -7279,7 +7903,7 @@ }, { "key": "updated_after", - "value": "2024-10-26T14:34:01.576Z", + "value": "2024-01-22T00:51:28.398Z", "type": "date-time" }, { @@ -7309,6 +7933,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -7357,6 +7986,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7419,6 +8053,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7439,7 +8078,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -7474,7 +8113,7 @@ }, { "key": "updated_after", - "value": "2024-12-24T13:12:17.029Z", + "value": "2024-11-13T22:12:04.968Z", "type": "date-time" } ] @@ -7492,6 +8131,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7513,7 +8157,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -7548,7 +8192,7 @@ }, { "key": "updated_after", - "value": "2024-11-08T08:16:40.240Z", + "value": "2025-04-14T22:19:54.875Z", "type": "date-time" } ], @@ -7573,6 +8217,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7628,7 +8277,7 @@ }, { "key": "updated_after", - "value": "2023-05-29T11:30:35.227Z", + "value": "2024-11-22T22:01:05.887Z", "type": "date-time" } ] @@ -7646,6 +8295,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7667,7 +8321,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -7702,7 +8356,7 @@ }, { "key": "updated_after", - "value": "2024-09-16T16:21:25.240Z", + "value": "2025-10-09T14:19:01.603Z", "type": "date-time" } ], @@ -7727,6 +8381,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7782,7 +8441,7 @@ }, { "key": "updated_after", - "value": "2024-09-21T11:03:04.845Z", + "value": "2025-12-16T21:47:39.716Z", "type": "date-time" } ] @@ -7800,6 +8459,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7856,7 +8520,7 @@ }, { "key": "updated_after", - "value": "2024-12-15T16:55:27.891Z", + "value": "2025-04-17T20:01:49.892Z", "type": "date-time" } ], @@ -7881,6 +8545,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -7900,7 +8569,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -7935,7 +8604,7 @@ }, { "key": "updated_after", - "value": "2025-09-09T14:45:41.967Z", + "value": "2025-02-06T20:20:50.747Z", "type": "date-time" }, { @@ -7958,6 +8627,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8013,6 +8687,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8032,7 +8711,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -8067,7 +8746,7 @@ }, { "key": "updated_after", - "value": "2025-09-04T13:09:06.950Z", + "value": "2026-06-02T14:07:36.077Z", "type": "date-time" }, { @@ -8090,6 +8769,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8145,6 +8829,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8164,7 +8853,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -8199,7 +8888,7 @@ }, { "key": "updated_after", - "value": "2023-04-20T20:22:04.958Z", + "value": "2026-10-04T18:04:14.419Z", "type": "date-time" }, { @@ -8222,6 +8911,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8277,6 +8971,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8331,7 +9030,7 @@ }, { "key": "updated_after", - "value": "2025-12-30T17:40:17.979Z", + "value": "2024-06-12T19:05:17.540Z", "type": "date-time" }, { @@ -8350,8 +9049,131 @@ "method": "GET", "header": [ { - "key": "x-account-id", - "value": "", + "key": "x-account-id", + "value": "", + "type": "string" + }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Accept", + "value": "application/json", + "type": "string" + } + ], + "url": { + "raw": "{{baseUrl}}/unified/ats/interviews/{id}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "unified", + "ats", + "interviews", + ":id" + ], + "query": [ + { + "key": "raw", + "value": false, + "type": "boolean" + }, + { + "key": "proxy", + "value": {}, + "type": "map" + }, + { + "key": "fields", + "value": "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields", + "type": "string" + } + ], + "variable": [ + { + "key": "id", + "value": "", + "type": "string" + } + ] + }, + "description": "" + } + }, + { + "name": "Create Interview Note", + "request": { + "method": "POST", + "header": [ + { + "key": "x-account-id", + "value": "", + "type": "string" + }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, + { + "key": "Accept", + "value": "application/json", + "type": "string" + } + ], + "body": { + "mode": "raw", + "raw": "{}" + }, + "url": { + "raw": "{{baseUrl}}/unified/ats/interviews/{id}/notes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "unified", + "ats", + "interviews", + ":id", + "notes" + ], + "variable": [ + { + "key": "id", + "value": "", + "type": "string" + } + ] + }, + "description": "" + } + }, + { + "name": "Update Interview Note", + "request": { + "method": "PATCH", + "header": [ + { + "key": "x-account-id", + "value": "", + "type": "string" + }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", "type": "string" }, { @@ -8360,8 +9182,12 @@ "type": "string" } ], + "body": { + "mode": "raw", + "raw": "{}" + }, "url": { - "raw": "{{baseUrl}}/unified/ats/interviews/{id}", + "raw": "{{baseUrl}}/unified/ats/interviews/{id}/notes/{subResourceId}", "host": [ "{{baseUrl}}" ], @@ -8369,30 +9195,20 @@ "unified", "ats", "interviews", - ":id" - ], - "query": [ - { - "key": "raw", - "value": true, - "type": "boolean" - }, - { - "key": "proxy", - "value": {}, - "type": "map" - }, - { - "key": "fields", - "value": "id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields", - "type": "string" - } + ":id", + "notes", + ":subResourceId" ], "variable": [ { "key": "id", "value": "", "type": "string" + }, + { + "key": "subResourceId", + "value": "", + "type": "string" } ] }, @@ -8409,6 +9225,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8428,7 +9249,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -8463,7 +9284,7 @@ }, { "key": "updated_after", - "value": "2023-06-28T02:12:50.953Z", + "value": "2025-11-05T15:40:43.604Z", "type": "date-time" }, { @@ -8496,6 +9317,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -8535,6 +9361,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8556,7 +9387,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -8591,7 +9422,7 @@ }, { "key": "updated_after", - "value": "2023-05-16T16:57:38.984Z", + "value": "2026-07-18T10:00:30.471Z", "type": "date-time" }, { @@ -8621,6 +9452,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8686,6 +9522,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -8733,6 +9574,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8795,6 +9641,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8814,7 +9665,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -8849,7 +9700,7 @@ }, { "key": "updated_after", - "value": "2024-03-22T06:32:58.021Z", + "value": "2024-03-16T19:22:07.134Z", "type": "date-time" } ] @@ -8867,6 +9718,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8887,7 +9743,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -8922,6 +9778,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -8941,7 +9802,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -8976,7 +9837,7 @@ }, { "key": "updated_after", - "value": "2024-05-12T01:59:12.211Z", + "value": "2026-03-02T08:57:01.759Z", "type": "date-time" }, { @@ -8999,6 +9860,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9054,6 +9920,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9108,7 +9979,7 @@ }, { "key": "updated_after", - "value": "2025-12-05T04:07:03.604Z", + "value": "2026-07-26T23:03:04.026Z", "type": "date-time" }, { @@ -9131,6 +10002,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9151,7 +10027,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -9186,6 +10062,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9240,7 +10121,7 @@ }, { "key": "updated_after", - "value": "2024-01-30T12:51:46.829Z", + "value": "2026-03-11T01:40:18.315Z", "type": "date-time" }, { @@ -9263,6 +10144,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9283,7 +10169,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -9318,6 +10204,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9337,7 +10228,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -9372,7 +10263,7 @@ }, { "key": "updated_after", - "value": "2024-07-25T01:20:48.803Z", + "value": "2024-02-29T13:18:23.203Z", "type": "date-time" }, { @@ -9400,6 +10291,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9460,6 +10356,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9514,7 +10415,7 @@ }, { "key": "updated_after", - "value": "2023-01-21T07:11:50.213Z", + "value": "2026-05-19T21:25:27.801Z", "type": "date-time" }, { @@ -9537,6 +10438,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -9576,6 +10482,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9596,7 +10507,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -9631,6 +10542,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9686,7 +10602,7 @@ }, { "key": "updated_after", - "value": "2024-01-14T12:07:50.192Z", + "value": "2026-10-14T04:15:01.236Z", "type": "date-time" } ] @@ -9704,6 +10620,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9760,6 +10681,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -9800,6 +10726,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -9849,6 +10780,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9869,7 +10805,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -9904,7 +10840,7 @@ }, { "key": "updated_after", - "value": "2023-02-04T21:29:28.328Z", + "value": "2024-06-29T12:06:54.333Z", "type": "date-time" } ] @@ -9922,6 +10858,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -9962,6 +10903,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -9983,7 +10929,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -10009,21 +10955,35 @@ } }, { - "name": "Delete Background Check Package", + "name": "Update Background Check Package", "request": { - "method": "DELETE", + "method": "PATCH", "header": [ { "key": "x-account-id", "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, { "key": "Accept", "value": "application/json", "type": "string" } ], + "body": { + "mode": "raw", + "raw": "{}" + }, "url": { "raw": "{{baseUrl}}/unified/ats/background_checks/packages/{id}", "host": [ @@ -10048,9 +11008,9 @@ } }, { - "name": "Update Background Check Package", + "name": "Delete Background Check Package", "request": { - "method": "PATCH", + "method": "DELETE", "header": [ { "key": "x-account-id", @@ -10058,8 +11018,8 @@ "type": "string" }, { - "key": "Content-Type", - "value": "application/json", + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -10068,10 +11028,6 @@ "type": "string" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, "url": { "raw": "{{baseUrl}}/unified/ats/background_checks/packages/{id}", "host": [ @@ -10105,6 +11061,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -10145,6 +11106,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -10194,6 +11160,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10249,7 +11220,7 @@ }, { "key": "updated_after", - "value": "2024-09-24T15:25:14.861Z", + "value": "2024-09-17T17:31:57.984Z", "type": "date-time" } ] @@ -10267,6 +11238,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10288,7 +11264,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -10328,6 +11304,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10382,7 +11363,7 @@ }, { "key": "updated_after", - "value": "2024-11-03T21:45:37.821Z", + "value": "2025-08-10T01:17:06.903Z", "type": "date-time" }, { @@ -10405,6 +11386,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -10444,6 +11430,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10504,6 +11495,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -10551,6 +11547,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10605,7 +11606,7 @@ }, { "key": "updated_after", - "value": "2025-03-11T05:07:47.512Z", + "value": "2024-12-07T21:24:04.180Z", "type": "date-time" } ] @@ -10623,6 +11624,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10678,6 +11684,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10732,7 +11743,7 @@ }, { "key": "updated_after", - "value": "2023-08-18T23:43:47.903Z", + "value": "2024-07-23T01:37:14.976Z", "type": "date-time" } ] @@ -10750,6 +11761,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10770,7 +11786,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -10805,6 +11821,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10860,7 +11881,7 @@ }, { "key": "updated_after", - "value": "2025-03-21T13:08:38.807Z", + "value": "2025-06-21T13:01:42.607Z", "type": "date-time" } ] @@ -10878,6 +11899,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -10934,7 +11960,7 @@ }, { "key": "updated_after", - "value": "2023-09-07T05:54:51.747Z", + "value": "2024-10-05T18:35:34.427Z", "type": "date-time" } ], @@ -10964,6 +11990,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11018,7 +12049,7 @@ }, { "key": "updated_after", - "value": "2023-03-05T14:23:56.519Z", + "value": "2025-04-21T02:53:41.707Z", "type": "date-time" }, { @@ -11041,6 +12072,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11092,21 +12128,35 @@ } }, { - "name": "Delete User", + "name": "Update User", "request": { - "method": "DELETE", + "method": "PATCH", "header": [ { "key": "x-account-id", "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "string" + }, { "key": "Accept", "value": "application/json", "type": "string" } ], + "body": { + "mode": "raw", + "raw": "{}" + }, "url": { "raw": "{{baseUrl}}/unified/iam/users/{id}", "host": [ @@ -11130,9 +12180,9 @@ } }, { - "name": "Update User", + "name": "Delete User", "request": { - "method": "PATCH", + "method": "DELETE", "header": [ { "key": "x-account-id", @@ -11140,8 +12190,8 @@ "type": "string" }, { - "key": "Content-Type", - "value": "application/json", + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -11150,10 +12200,6 @@ "type": "string" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, "url": { "raw": "{{baseUrl}}/unified/iam/users/{id}", "host": [ @@ -11186,6 +12232,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11205,7 +12256,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -11240,7 +12291,7 @@ }, { "key": "updated_after", - "value": "2025-02-02T04:37:08.867Z", + "value": "2025-02-18T00:23:03.771Z", "type": "date-time" }, { @@ -11263,6 +12314,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11323,6 +12379,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11377,7 +12438,7 @@ }, { "key": "updated_after", - "value": "2023-01-28T01:08:57.377Z", + "value": "2024-03-14T16:56:03.501Z", "type": "date-time" }, { @@ -11400,6 +12461,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11420,7 +12486,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -11460,6 +12526,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11479,7 +12550,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -11514,7 +12585,7 @@ }, { "key": "updated_after", - "value": "2024-05-12T06:02:30.477Z", + "value": "2025-08-11T02:10:46.448Z", "type": "date-time" }, { @@ -11537,6 +12608,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11602,6 +12678,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11657,7 +12738,7 @@ }, { "key": "updated_after", - "value": "2025-12-21T09:52:32.421Z", + "value": "2024-08-25T17:15:29.799Z", "type": "date-time" } ] @@ -11675,6 +12756,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -11715,6 +12801,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11736,7 +12827,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -11771,6 +12862,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -11819,6 +12915,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11839,7 +12940,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -11874,7 +12975,7 @@ }, { "key": "updated_after", - "value": "2023-10-16T14:25:54.471Z", + "value": "2024-01-23T15:12:14.003Z", "type": "date-time" } ] @@ -11892,6 +12993,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -11932,6 +13038,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -11953,7 +13064,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -11988,6 +13099,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12036,6 +13152,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12056,7 +13177,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -12091,7 +13212,7 @@ }, { "key": "updated_after", - "value": "2023-12-17T17:43:52.087Z", + "value": "2025-02-24T06:38:03.380Z", "type": "date-time" } ] @@ -12109,6 +13230,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12149,6 +13275,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12170,7 +13301,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -12205,6 +13336,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12253,6 +13389,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12308,7 +13449,7 @@ }, { "key": "updated_after", - "value": "2025-06-29T19:53:54.840Z", + "value": "2025-11-20T08:44:18.290Z", "type": "date-time" } ] @@ -12326,6 +13467,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12366,6 +13512,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12422,6 +13573,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12470,6 +13626,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12490,7 +13651,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -12525,7 +13686,7 @@ }, { "key": "updated_after", - "value": "2023-10-27T19:14:58.861Z", + "value": "2026-05-24T15:49:26.110Z", "type": "date-time" } ] @@ -12543,6 +13704,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12583,6 +13749,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12604,7 +13775,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -12639,6 +13810,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12687,6 +13863,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12706,7 +13887,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -12741,7 +13922,7 @@ }, { "key": "updated_after", - "value": "2025-11-10T06:13:54.282Z", + "value": "2026-01-23T11:41:29.840Z", "type": "date-time" } ] @@ -12759,6 +13940,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12779,7 +13965,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -12814,6 +14000,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12833,7 +14024,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -12868,7 +14059,7 @@ }, { "key": "updated_after", - "value": "2025-11-04T07:38:09.644Z", + "value": "2026-03-12T00:25:52.109Z", "type": "date-time" } ] @@ -12886,6 +14077,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -12925,6 +14121,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -12945,7 +14146,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -12980,6 +14181,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -13032,6 +14238,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13086,12 +14297,12 @@ }, { "key": "updated_after", - "value": "2023-08-22T18:57:29.709Z", + "value": "2025-07-21T22:45:05.685Z", "type": "date-time" } ] }, - "description": "" + "description": "Retrieve a list of course type learning objects. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose." } }, { @@ -13104,6 +14315,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13124,7 +14340,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -13146,7 +14362,7 @@ } ] }, - "description": "" + "description": "Retrieve a course type learning object by its identifier. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose." } }, { @@ -13159,6 +14375,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13190,7 +14411,7 @@ }, { "key": "fields", - "value": "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields", + "value": "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields", "type": "string" }, { @@ -13215,7 +14436,7 @@ }, { "key": "updated_after", - "value": "2023-08-16T09:17:34.312Z", + "value": "2025-04-10T10:55:35.652Z", "type": "date-time" }, { @@ -13237,7 +14458,7 @@ } ] }, - "description": "" + "description": "Retrieve a list of assignment type learning records for a user. \n\nThese are the records linking a user to learning objects. \n\nThey can be pending, in progress, or completed." } }, { @@ -13250,6 +14471,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -13285,7 +14511,7 @@ } ] }, - "description": "" + "description": "Create an assignment type learning record for a user. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending or in progress." } }, { @@ -13298,6 +14524,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13347,11 +14578,11 @@ } ] }, - "description": "" + "description": "Retrieve an assignment type learning record for a user by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed." } }, { - "name": "Batch Upsert Content", + "name": "Batch Upsert External Linking Learning Objects", "request": { "method": "POST", "header": [ @@ -13360,6 +14591,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -13387,13 +14623,13 @@ "batch" ] }, - "description": "" + "description": "Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking. \n\n**Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects." } }, { - "name": "List Content", + "name": "Upsert External Linking Learning Objects", "request": { - "method": "GET", + "method": "PUT", "header": [ { "key": "x-account-id", @@ -13401,75 +14637,8 @@ "type": "string" }, { - "key": "Accept", - "value": "application/json", - "type": "string" - } - ], - "url": { - "raw": "{{baseUrl}}/unified/lms/content", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "unified", - "lms", - "content" - ], - "query": [ - { - "key": "raw", - "value": true, - "type": "boolean" - }, - { - "key": "proxy", - "value": {}, - "type": "map" - }, - { - "key": "fields", - "value": "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields", - "type": "string" - }, - { - "key": "filter", - "value": {}, - "type": "class" - }, - { - "key": "page", - "value": "", - "type": "string" - }, - { - "key": "page_size", - "value": "", - "type": "string" - }, - { - "key": "next", - "value": "", - "type": "string" - }, - { - "key": "updated_after", - "value": "2024-05-23T01:53:16.665Z", - "type": "date-time" - } - ] - }, - "description": "" - } - }, - { - "name": "Upsert Content", - "request": { - "method": "PUT", - "header": [ - { - "key": "x-account-id", - "value": "", + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -13498,11 +14667,11 @@ "content" ] }, - "description": "" + "description": "Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. \n\n**Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects." } }, { - "name": "Get Content", + "name": "List Content", "request": { "method": "GET", "header": [ @@ -13511,6 +14680,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13518,15 +14692,14 @@ } ], "url": { - "raw": "{{baseUrl}}/unified/lms/content/{id}", + "raw": "{{baseUrl}}/unified/lms/content", "host": [ "{{baseUrl}}" ], "path": [ "unified", "lms", - "content", - ":id" + "content" ], "query": [ { @@ -13543,23 +14716,41 @@ "key": "fields", "value": "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields", "type": "string" - } - ], - "variable": [ + }, { - "key": "id", + "key": "filter", + "value": {}, + "type": "class" + }, + { + "key": "page", + "value": "", + "type": "string" + }, + { + "key": "page_size", + "value": "", + "type": "string" + }, + { + "key": "next", "value": "", "type": "string" + }, + { + "key": "updated_after", + "value": "2024-10-31T06:44:43.765Z", + "type": "date-time" } ] }, - "description": "" + "description": "Retrieve a list of content type learning objects. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned." } }, { - "name": "Update Content", + "name": "Get Content", "request": { - "method": "PATCH", + "method": "GET", "header": [ { "key": "x-account-id", @@ -13567,8 +14758,8 @@ "type": "string" }, { - "key": "Content-Type", - "value": "application/json", + "key": "Prefer", + "value": "heartbeat", "type": "string" }, { @@ -13577,10 +14768,6 @@ "type": "string" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, "url": { "raw": "{{baseUrl}}/unified/lms/content/{id}", "host": [ @@ -13592,6 +14779,23 @@ "content", ":id" ], + "query": [ + { + "key": "raw", + "value": false, + "type": "boolean" + }, + { + "key": "proxy", + "value": {}, + "type": "map" + }, + { + "key": "fields", + "value": "id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields", + "type": "string" + } + ], "variable": [ { "key": "id", @@ -13600,7 +14804,7 @@ } ] }, - "description": "" + "description": "Retrieve a content type learning object by its identifier. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned." } }, { @@ -13613,6 +14817,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13644,7 +14853,7 @@ }, { "key": "fields", - "value": "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,unified_custom_fields", + "value": "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields", "type": "string" }, { @@ -13669,7 +14878,7 @@ }, { "key": "updated_after", - "value": "2025-08-04T18:51:28.290Z", + "value": "2024-05-08T19:33:28.581Z", "type": "date-time" } ], @@ -13681,7 +14890,7 @@ } ] }, - "description": "" + "description": "Retrieve a list of completed learning records for a user. \n\nThese are the records of a user completing learning objects." } }, { @@ -13694,6 +14903,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -13729,7 +14943,7 @@ } ] }, - "description": "" + "description": "Create a completed learning record for a user. \n\nThis is the record of a user completing a learning object." } }, { @@ -13742,6 +14956,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13764,7 +14983,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -13791,7 +15010,7 @@ } ] }, - "description": "" + "description": "Retrieve a completed learning record for a user by its identifier. \n\nThis is the record of a user completing a learning object." } }, { @@ -13804,6 +15023,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13836,7 +15060,7 @@ } ] }, - "description": "" + "description": "Delete a completion type learning record for a user. \n\nThis is a record of a user completing a learning object." } }, { @@ -13849,6 +15073,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13868,7 +15097,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -13878,7 +15107,7 @@ }, { "key": "fields", - "value": "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,unified_custom_fields", + "value": "id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields", "type": "string" }, { @@ -13903,12 +15132,12 @@ }, { "key": "updated_after", - "value": "2023-05-25T17:55:10.089Z", + "value": "2026-02-24T16:16:37.395Z", "type": "date-time" } ] }, - "description": "" + "description": "Retrieve a list of completed learning records. These are the records of a user completing learning objects." } }, { @@ -13921,6 +15150,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13941,7 +15175,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -13963,7 +15197,7 @@ } ] }, - "description": "" + "description": "Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object." } }, { @@ -13976,6 +15210,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -13996,7 +15235,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -14031,6 +15270,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14050,7 +15294,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -14085,7 +15329,7 @@ }, { "key": "updated_after", - "value": "2023-07-20T20:59:34.122Z", + "value": "2024-06-07T18:04:31.662Z", "type": "date-time" } ] @@ -14103,6 +15347,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14157,7 +15406,7 @@ }, { "key": "updated_after", - "value": "2024-06-18T21:49:56.662Z", + "value": "2025-01-24T18:02:14.843Z", "type": "date-time" } ] @@ -14175,6 +15424,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14195,7 +15449,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -14230,6 +15484,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14285,6 +15544,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14339,7 +15603,7 @@ }, { "key": "updated_after", - "value": "2025-03-31T12:50:52.284Z", + "value": "2026-09-17T11:26:38.524Z", "type": "date-time" } ] @@ -14357,6 +15621,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14376,7 +15645,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -14386,7 +15655,7 @@ }, { "key": "fields", - "value": "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields", + "value": "id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields", "type": "string" }, { @@ -14411,7 +15680,7 @@ }, { "key": "updated_after", - "value": "2023-04-02T10:20:37.470Z", + "value": "2025-08-28T04:52:14.624Z", "type": "date-time" }, { @@ -14426,7 +15695,7 @@ } ] }, - "description": "" + "description": "Retrieve a list of assignment type learning records. \n\nThese are the records linking a user to a learning object. \n\nThey can be pending, in progress, or completed." } }, { @@ -14439,6 +15708,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14481,7 +15755,7 @@ } ] }, - "description": "" + "description": "Retrieve an assignment type learning record by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed." } } ] @@ -14499,6 +15773,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14553,7 +15832,7 @@ }, { "key": "updated_after", - "value": "2025-11-20T06:46:28.205Z", + "value": "2024-11-16T04:38:54.761Z", "type": "date-time" } ] @@ -14571,6 +15850,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -14610,6 +15894,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14665,6 +15954,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -14712,6 +16006,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14766,7 +16065,7 @@ }, { "key": "updated_after", - "value": "2023-04-20T22:07:54.686Z", + "value": "2024-01-19T00:09:53.916Z", "type": "date-time" } ] @@ -14784,6 +16083,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14804,7 +16108,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -14839,6 +16143,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14895,7 +16204,7 @@ }, { "key": "updated_after", - "value": "2025-01-04T05:29:05.430Z", + "value": "2026-05-10T12:39:43.913Z", "type": "date-time" } ], @@ -14920,6 +16229,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -14942,7 +16256,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -15040,6 +16354,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15061,7 +16380,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -15096,7 +16415,7 @@ }, { "key": "updated_after", - "value": "2024-10-04T16:55:58.841Z", + "value": "2024-03-11T02:16:45.552Z", "type": "date-time" } ], @@ -15121,6 +16440,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15183,6 +16507,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15202,7 +16531,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -15237,7 +16566,7 @@ }, { "key": "updated_after", - "value": "2025-12-07T08:01:55.761Z", + "value": "2026-08-18T15:35:38.302Z", "type": "date-time" } ] @@ -15255,6 +16584,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15275,7 +16609,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -15310,6 +16644,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15329,7 +16668,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -15364,7 +16703,7 @@ }, { "key": "updated_after", - "value": "2025-11-19T21:08:28.843Z", + "value": "2024-09-10T22:40:46.497Z", "type": "date-time" } ] @@ -15382,6 +16721,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15402,7 +16746,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -15437,6 +16781,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15493,7 +16842,7 @@ }, { "key": "updated_after", - "value": "2025-10-28T17:59:56.921Z", + "value": "2026-05-25T22:13:29.488Z", "type": "date-time" } ], @@ -15518,6 +16867,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15580,6 +16934,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15636,7 +16995,7 @@ }, { "key": "updated_after", - "value": "2025-08-16T05:16:14.427Z", + "value": "2024-11-17T03:36:20.029Z", "type": "date-time" } ], @@ -15661,6 +17020,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15682,7 +17046,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -15717,7 +17081,7 @@ }, { "key": "updated_after", - "value": "2025-07-19T10:36:40.605Z", + "value": "2025-11-08T04:37:42.615Z", "type": "date-time" } ], @@ -15853,6 +17217,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -15872,7 +17241,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -15907,7 +17276,7 @@ }, { "key": "updated_after", - "value": "2023-01-15T12:10:56.303Z", + "value": "2025-01-15T13:37:49.640Z", "type": "date-time" }, { @@ -15947,6 +17316,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16007,6 +17381,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16026,7 +17405,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -16061,7 +17440,7 @@ }, { "key": "updated_after", - "value": "2025-12-12T02:02:24.972Z", + "value": "2025-06-08T07:03:09.203Z", "type": "date-time" }, { @@ -16096,6 +17475,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16156,6 +17540,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16175,7 +17564,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -16210,7 +17599,7 @@ }, { "key": "updated_after", - "value": "2024-12-01T20:41:06.257Z", + "value": "2025-02-07T23:14:58.127Z", "type": "date-time" } ] @@ -16228,6 +17617,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16288,6 +17682,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16307,7 +17706,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -16342,7 +17741,7 @@ }, { "key": "updated_after", - "value": "2025-06-20T00:59:05.475Z", + "value": "2024-07-27T01:45:34.109Z", "type": "date-time" } ] @@ -16360,6 +17759,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16380,7 +17784,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -16415,6 +17819,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -16455,6 +17864,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -16499,6 +17913,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16518,7 +17937,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -16553,7 +17972,7 @@ }, { "key": "updated_after", - "value": "2023-09-03T20:26:06.468Z", + "value": "2024-04-17T05:42:04.752Z", "type": "date-time" } ] @@ -16571,6 +17990,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -16610,6 +18034,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16630,7 +18059,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -16723,6 +18152,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16779,7 +18213,7 @@ }, { "key": "updated_after", - "value": "2025-12-02T07:40:27.262Z", + "value": "2026-11-19T01:47:41.445Z", "type": "date-time" } ], @@ -16804,6 +18238,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16866,6 +18305,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16920,7 +18364,7 @@ }, { "key": "updated_after", - "value": "2025-04-28T08:32:27.742Z", + "value": "2024-12-31T03:03:00.284Z", "type": "date-time" } ] @@ -16938,6 +18382,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -16993,6 +18442,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17049,7 +18503,7 @@ }, { "key": "updated_after", - "value": "2024-03-22T08:04:18.382Z", + "value": "2024-09-11T12:41:12.752Z", "type": "date-time" } ], @@ -17074,6 +18528,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17134,6 +18593,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -17178,6 +18642,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17232,7 +18701,7 @@ }, { "key": "updated_after", - "value": "2023-02-28T13:20:54.923Z", + "value": "2026-03-06T06:02:02.963Z", "type": "date-time" } ] @@ -17250,6 +18719,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17270,7 +18744,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -17305,6 +18779,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17326,7 +18805,7 @@ "query": [ { "key": "raw", - "value": true, + "value": false, "type": "boolean" }, { @@ -17361,7 +18840,7 @@ }, { "key": "updated_after", - "value": "2025-04-24T13:21:21.631Z", + "value": "2024-06-10T01:17:04.418Z", "type": "date-time" } ], @@ -17386,6 +18865,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17448,6 +18932,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17504,7 +18993,7 @@ }, { "key": "updated_after", - "value": "2023-04-09T04:55:05.565Z", + "value": "2026-01-06T13:32:43.889Z", "type": "date-time" } ], @@ -17529,6 +19018,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17551,7 +19045,7 @@ "query": [ { "key": "raw", - "value": false, + "value": true, "type": "boolean" }, { @@ -17591,6 +19085,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -17640,6 +19139,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json", @@ -17696,7 +19200,7 @@ }, { "key": "updated_after", - "value": "2024-04-05T21:52:12.474Z", + "value": "2025-09-02T21:01:43.273Z", "type": "date-time" } ], @@ -17721,6 +19225,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Content-Type", "value": "application/json", @@ -17769,6 +19278,11 @@ "value": "", "type": "string" }, + { + "key": "Prefer", + "value": "heartbeat", + "type": "string" + }, { "key": "Accept", "value": "application/json",