{ "openapi": "3.0.1", "info": { "title": "Idealist Scraper", "description": "Scrape Idealist.org - the world's largest volunteer opportunity, nonprofit job, internship, and event listing directory. Search by keyword, cause area, location, remote/on-site, organization type, and more.", "version": "1.0", "x-build-id": "ihve3fYBWTaCdzhob" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~idealist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-idealist-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~idealist-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-idealist-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~idealist-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-idealist-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byIds" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text keyword, skill, or interest (e.g. \"education\", \"data analyst\", \"environment\"). Leave blank to browse the most recent listings for the selected type/filters.", "default": "education" }, "listingType": { "title": "Listing type (mode=search)", "enum": [ "", "VOLOP", "JOB", "INTERNSHIP", "EVENT", "ORG" ], "type": "string", "description": "The kind of listing to search.", "default": "VOLOP" }, "orgType": { "title": "Organization type (mode=search)", "enum": [ "", "NONPROFIT", "GOVERNMENT", "CORPORATION", "CONSULTANT", "COMMUNITY", "RECRUITER" ], "type": "string", "description": "Restrict to listings posted by a specific kind of organization.", "default": "" }, "locationType": { "title": "Work location (mode=search)", "enum": [ "", "ONSITE", "REMOTE", "HYBRID" ], "type": "string", "description": "Restrict to on-site, remote, or hybrid listings.", "default": "" }, "areaOfFocus": { "title": "Cause area (mode=search)", "enum": [ "", "COMMUNITY_DEVELOPMENT", "EDUCATION", "VOLUNTEERING", "HEALTH_MEDICINE", "SENIORS_RETIREMENT", "CHILDREN_YOUTH", "HOUSING_HOMELESSNESS", "ARTS_MUSIC", "HUMAN_RIGHTS_CIVIL_LIBERTIES", "ENVIRONMENT", "MENTAL_HEALTH", "WOMEN", "DISABILITY", "HUNGER_FOOD_SECURITY", "VETERANS", "ECONOMIC_DEVELOPMENT", "CIVIC_ENGAGEMENT", "FAMILY", "ANIMALS", "RELIGION_SPIRITUALITY", "INTERNATIONAL_RELATIONS", "SCIENCE_TECHNOLOGY", "SPORTS_RECREATION", "POVERTY", "DISASTER_RELIEF", "IMMIGRANTS_OR_REFUGEES", "POLICY", "JOB_WORKPLACE", "PHILANTHROPY", "LEGAL_ASSISTANCE", "CRIME_SAFETY", "RACE_ETHNICITY", "MEDIA", "ENTREPRENEURSHIP", "RESEARCH_SOCIAL_SCIENCE", "LGBTQ", "CLIMATE_CHANGE", "AGRICULTURE", "URBAN_AREAS", "RURAL_AREAS", "CONFLICT_RESOLUTION", "VICTIM_SUPPORT", "ENERGY", "SUBSTANCE_ABUSE_ADDICTION", "COMMUNICATIONS_ACCESS", "TRANSPORTATION", "FINANCIAL_LITERACY_PERSONAL_FINANCE", "PRISON_REFORM", "SEXUAL_ABUSE_HUMAN_TRAFFICKING", "REPRODUCTIVE_HEALTH_RIGHTS", "CONSUMER_PROTECTION", "WATER_SANITATION", "MEN", "TRAVEL_HOSPITALITY", "TRANSPARENCY_OVERSIGHT", "MICROFINANCE" ], "type": "string", "description": "Restrict to a specific cause area / issue focus.", "default": "" }, "country": { "title": "Country (mode=search)", "enum": [ "", "US", "AR", "CA", "GB", "IN", "MX", "UG", "CO", "FR", "ES", "BR", "KE", "PE", "GH", "EC", "TZ", "AU", "NG", "NP", "DE", "ZA", "GT", "CM", "CL", "TH", "NL", "CH", "VE", "CR", "KH", "BO", "TG", "BE", "PK", "IL", "DO", "IT", "HN", "ID", "PH", "IE", "NI", "CN", "UY", "GR", "HT", "PR", "RW", "ZM", "SN", "NZ", "VN", "CD", "MA", "LR", "SL", "PS", "PA", "RO", "DK", "LK", "MY", "MW", "BD", "CI", "SE", "PT", "BJ", "PL", "JP", "EG", "SV", "UA", "MZ", "RU", "SG", "AT", "KR", "ET", "MG", "PY", "HK", "BZ", "SO", "BF", "MM", "BG", "ZW", "CZ", "AF", "LA", "HU", "NO", "GM", "JO", "LB", "TR", "RS", "LT", "HR" ], "type": "string", "description": "Restrict to listings located in a specific country.", "default": "" }, "usState": { "title": "U.S. state (mode=search)", "enum": [ "", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR" ], "type": "string", "description": "Restrict to listings located in a specific U.S. state (only meaningful when country=United States, or left blank).", "default": "" }, "skill": { "title": "Skill (mode=search)", "enum": [ "", "HOSPICE_CARE", "PEOPLE_SKILLS", "HEALTH_WELLNESS", "PATIENT_CARE", "ELDER_CARE", "COMMUNITY_ENGAGEMENT_OUTREACH", "HEALTHCARE_PROVIDER_PRACTITIONER", "ADMINISTRATIVE_OFFICE_SUPPORT", "VETERAN_CARE", "ADVOCACY", "RELATIONSHIP_BUILDING", "COUNSELING", "COMMUNICATIONS", "CUSTOMER_SERVICE", "READING_WRITING", "PUBLIC_SPEAKING", "CASE_SOCIAL_WORK", "ARTS_CRAFTS", "FUNDRAISING", "DISASTER_RELIEF", "EDUCATION", "ANIMAL_THERAPY", "MENTOR_TUTOR", "MUSIC_THERAPY", "MUSIC", "COMMUNITY_BELONGING", "YOUTH_SERVICES", "PROBLEM_SOLVING", "MARKETING", "SOCIAL_MEDIA", "TECHNOLOGY_SUPPORT_WEB_DESIGN", "ANIMAL_CARE", "VOLUNTEER_COORDINATION", "TEACHING_AND_INSTRUCTION", "EVENT_SUPPORT", "PROJECT_MANAGEMENT", "COMMUNITY_ORGANIZING", "DATA_ENTRY", "RESEARCH", "LEADERSHIP", "NURSING", "NETWORKING", "PUBLIC_RELATIONS", "LANGUAGES", "BUSINESS_DEVELOPMENT", "CHILD_DEVELOPMENT", "ACCOUNTING_FINANCE", "OPERATIONS", "PROGRAM_MANAGEMENT", "VISUAL_ARTS", "GARDENING", "LOBBYING", "CONSERVATION", "STRATEGIC_PLANNING", "PHYSICAL_SERVICE", "FOOD_DELIVERY_DISTRIBUTION", "STEM", "PHOTOGRAPHY", "CORPORATE_RESPONSIBILITY", "FOOD_SERVICE", "GRAPHIC_DESIGN", "SPORTS_FITNESS_COACHING", "DATA_ANALYSIS", "ESL", "CHILD_WELFARE", "HUMAN_RESOURCES", "GRANTS_ADMINISTRATION", "DIRECT_SERVICES", "DIVERSITY_EQUITY_INCLUSION", "PROJECT_RESEARCH_STUDY", "CHILD_CARE", "WRITING_EDITORIAL", "BOARD_COMMITTEE", "TECHNOLOGY_IT", "CRISIS_INTERVENTION", "SUSTAINABILITY", "MASSAGE_THERAPY", "PARTNERSHIPS", "DESIGN", "EQUIPMENT_FACILITIES", "LEGAL", "DONATION_DRIVE", "ART_THERAPY", "CONSTRUCTION_HOME_REPAIR", "EMPLOYEE_ENGAGEMENT", "DATABASE_ADMINISTRATION", "VIDEOGRAPHY", "CONFLICT_RESOLUTION", "ARCHIVING_DATA_ENTRY", "PUBLIC_HEALTH", "CORPORATE_PHILANTHROPY", "ADMINISTRATIVE", "WRITING_JOURNALISM", "DEVELOPMENT_FUNDRAISING", "HABITAT_RESTORATION", "FARMING", "THEATER", "STRATEGY_PLANNING", "TEACHING_INSTRUCTION", "CITIZENSHIP", "DANCE", "EVENTS", "DATA_EVALUATION_ANALYSIS", "INVESTIGATIONS", "MARKETING_COMMUNICATIONS", "ARTS_PHOTOGRAPHY", "SAFETY_RESOURCE_PROTECTION", "PHOTOGRAPHY_MEDIA_DESIGN", "SUPPLIES_PROCUREMENT_DISTRIBUTION", "STRATEGY", "GRANT_WRITING", "DATA_ENTRY_ANALYSIS" ], "type": "string", "description": "Restrict to listings tagged with a specific skill / role focus (Idealist's \"Skills\" search filter).", "default": "" }, "professionalLevel": { "title": "Experience level (mode=search, listingType=Nonprofit Job)", "enum": [ "", "ENTRY_LEVEL", "PROFESSIONAL", "MANAGERIAL", "DIRECTOR", "EXECUTIVE", "NONE" ], "type": "string", "description": "Restrict nonprofit-job listings to a specific experience level.", "default": "" }, "jobType": { "title": "Job type (mode=search, listingType=Nonprofit Job)", "enum": [ "", "FULL_TIME", "PART_TIME", "TEMPORARY", "CONTRACT" ], "type": "string", "description": "Restrict nonprofit-job listings to full-time, part-time, temporary, or contract.", "default": "" }, "education": { "title": "Education required (mode=search, listingType=Nonprofit Job)", "enum": [ "", "NO_REQUIREMENT", "HIGH_SCHOOL", "TWO_YEAR_DEGREE", "FOUR_YEAR_DEGREE", "MASTERS_DEGREE", "JD", "MD", "PHD", "OTHER" ], "type": "string", "description": "Restrict nonprofit-job listings to a specific minimum education requirement.", "default": "" }, "canBeDoneInADay": { "title": "Can be done in a day only (mode=search, listingType=Volunteer Opportunity)", "type": "boolean", "description": "Only return volunteer opportunities that can be completed in a single day.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest" ], "type": "string", "description": "Order results by best match or by most recently posted.", "default": "relevance" }, "listingIds": { "title": "Listing IDs or URLs (mode=byIds)", "type": "array", "description": "Idealist listing IDs (32-character hex) or full listing URLs, e.g. https://www.idealist.org/en/volunteer-opportunity/-slug.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records. Idealist's search index exposes at most 1000 results per query/filter combination.", "default": 30 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }