The description of the job is some richtext.
", "expires": "2019-08-22T17:34:23.848076Z", "org": { "id": "f5f56cb69a66468ecc52c9bbb16e99d6", "name": "Example Organization", "url": { "en": "https://idealist.org/en/nonprofit/...", "es": "https://idealist.org/es/ong/...", "pt": "https://idealist.org/pt/ong/..." }, "logo": "https://imagehost.com/f5f56cb69a66468ecc52c9bbb16e99d6-logo.png", "areasOfFocus": ["IMMIGRANTS_OR_REFUGEES", "LEGAL_ASSISTANCE"], "orgType": "NONPROFIT", "is501c3": false, "isBCorp": false, "isSocialEnterprise": false, "locale": "en", "governmentId": "abcdef", "address": { "full": "123 Broadway, New York, NY, United States", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003 } }, "address": { "full": "123 Broadway, New York, NY, United States", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003, "cityOnly": false }, "applyEmail": "apply@example.org", "applyUrl": "https://example.org/", "applyText": "Some rich text
", "applyOnIdealist": false, "benefits": "Comprehensive benefit package
", "salaryMinimum": "50000.00", "salaryMaximum": null, "salaryCurrency": "USD", "salaryPeriod": "YEAR", "salaryDetails": "Based on experience", "professionalLevel": "PROFESSIONAL", "languageProficiency": null, "education": "FOUR_YEAR_DEGREE", "educationDetails": null, "applicationDeadline": "2019-09-17", "startDate": "2019-10-01", "endDate": null, "isFullTime": true, "isTemporary": false, "isContract": true, "locationType": "REMOTE", "remoteZone": "CITY", "remoteCountry": null, "functions": ["ADMINISTRATIVE", "LEGAL"], "areasOfFocus": ["IMMIGRANTS_OR_REFUGEES", "LEGAL_ASSISTANCE"], "url": { "en": "https://www.idealist.org/en/nonprofit-job/...", "es": "https://www.idealist.org/es/ong-empleo/...", "pt": "https://www.idealist.org/pt/ong-emprego/..." } } } ``` ### Internships `GET /api/v1/listings/internships` Sample response: ```json { "internships": [{ "id": "0b6c1534f850452d855a646d203f617d", "firstPublished": "2019-06-24T10:07:42.822915Z", "updated": "2019-06-24T10:07:42.825251Z", "name": "Executive Director Intern", "url": { "en": "https://www.idealist.org/en/nonprofit-internship/...", "es": "https://www.idealist.org/es/ong-pasantia/...", "pt": "https://www.idealist.org/pt/ong-estagio/..." }, "isPublished": true }, ... ], "hasMore": true } ``` It works in the same manner as jobs: up to 100 are returned, and paging is done using `since` with the last (most recently) updated internship. ### Internship Details `GET /api/v1/listings/internships/{internship_id}` Sample response: ```json { "internship": { "id": "d6d4dc8ab6c34346a160554442d55a65", "firstPublished": "2019-07-23T18:01:43.119618Z", "updated": "2019-07-23T18:01:43.120519Z", "name": "Communications Intern", "description": "Rich text description
", "expires": "2019-08-22T18:01:43.119618Z", "org": { "id": "f5f56cb69a66468ecc52c9bbb16e99d6", "name": "Example Organization", "url": { "en": "https://idealist.org/en/nonprofit/...", "es": "https://idealist.org/es/ong/...", "pt": "https://idealist.org/pt/ong/..." }, "logo": "https://imagehost.com/f5f56cb69a66468ecc52c9bbb16e99d6-logo.png", "areasOfFocus": ["IMMIGRANTS_OR_REFUGEES", "LEGAL_ASSISTANCE"], "orgType": "NONPROFIT", "is501c3": false, "isBCorp": false, "isSocialEnterprise": false, "locale": "en", "governmentId": "abcdef", "address": { "full": "123 Broadway, New York, NY, United States", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003 } }, "address": { "full": "123 Broadway, New York, NY, United States", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003, "cityOnly": false }, "applyEmail": "resumes@example.org", "applyUrl": "http://example.org/page-url", "applyText": "Rich text on how to apply.
", "applyOnIdealist": false, "benefits": null, "paid": false, "wage": null, "academicCredits": false, "paymentOk": true, "locationType": "ONSITE", "remoteZone": null, "remoteCountry": null, "hoursPerWeek": "20", "isCovid": false, "isPostedAnonymously": false, "applicationDeadline": "2019-08-16", "startDate": null, "endDate": "2019-12-13", "functions": ["ADVOCACY", "MARKETING_COMMUNICATIONS", "RESEARCH", "SOCIAL_MEDIA", "WRITING_JOURNALISM"], "url": { "en": "https://www.idealist.org/en/nonprofit-internship/...", "es": "https://www.idealist.org/es/ong-pasantia/...", "pt": "https://www.idealist.org/pt/ong-estagio/..." } } } ``` ### Volunteer Listings `GET /api/v1/listings/volops` Sample response: ```json { "volops": [{ "id": "0b6c1534f850452d855a646d203f617d", "firstPublished": "2019-06-24T10:07:42.822915Z", "updated": "2019-06-24T10:07:42.825251Z", "name": "Volunteer Driver", "url": { "en": "https://www.idealist.org/en/volunter-opportunity/...", "es": "https://www.idealist.org/es/oportunidad-voluntariado/...", "pt": "https://www.idealist.org/pt/oportunidade-voluntariado/..." }, "isPublished": true }, ... ], "hasMore": true } ``` It works in the same manner as jobs: up to 100 are returned, and paging is done using `since` with the last (most recently) updated volop. ### Volunteer Listing Details `GET /api/v1/listings/volops/{volop_id}` Sample response: ```json { "volop": { "id": "d6d4dc8ab6c34346a160554442d55a65", "firstPublished": "2019-07-23T18:01:43.119618Z", "updated": "2019-07-23T18:01:43.120519Z", "name": "Communications Intern", "description": "Rich text description
", "expires": "2019-08-22T18:01:43.119618Z", "org": { "id": "f5f56cb69a66468ecc52c9bbb16e99d6", "name": "Example Organization", "url": { "en": "https://idealist.org/en/nonprofit/...", "es": "https://idealist.org/es/ong/...", "pt": "https://idealist.org/pt/ong/..." }, "logo": "https://imagehost.com/f5f56cb69a66468ecc52c9bbb16e99d6-logo.png", "areasOfFocus": ["IMMIGRANTS_OR_REFUGEES", "LEGAL_ASSISTANCE"], "orgType": "NONPROFIT", "is501c3": false, "isBCorp": false, "isSocialEnterprise": false, "locale": "en", "governmentId": "abcdef", "address": { "full": "123 Broadway, New York, NY, United States", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003 } }, "locale": "en", "isVirtual": false, "isCovid": false, "isPostedAnonymously": false, "address": { "full": "123 Broadway, New York, NY, United States", "description": "Town Hall", "line1": "123 Broadway", "line2": null, "city": "New York", "state": "New York", "stateCode": "NY", "zipcode": "10000", "country": "US", "latitude": 41.707002, "longitude": -75.010003, "cityOnly": false }, "directions": "Rich text on directions to get to the location.
", "actionType": "VOLOP", "actionSubType": null, "actionTypeText": null, "applyEmail": "resumes@example.org", "applyUrl": "http://example.org/page-url", "applyText": "Rich text on how to apply.
", "applyOnIdealist": false, "benefits": null, "paid": false, "wage": null, "academicCredits": false, "paymentOk": true, "locationType": "REMOTE", "remoteZone": "CITY", "remoteCountry": null, "welcomeGroups": true, "welcomeFamilies": true, "welcomeTeens": true, "welcomeIntl": true, "welcomeAge55Plus": true, "welcomePrivateCorpGroups": true, "detailsStipendProvided": true, "detailsTrainingProvided": true, "detailsHousingAvailable": true, "detailsCulturalSupport": true, "detailsWheelchairAccessible": true, "orientationRequired": true, "backgroundCheckRequired": true, "driversLicenseRequired": true, "feeRequired": true, "feeAmount": "25.00", "isRecurring": true, "timesOfDay": "WEEKDAYS", "expectedTime": "FEW_HOURS_WEEK", "startDate": null, "endDate": "2019-12-13", "startTime": null, "endTime": "02:00:00", "timezone": "America/New_York", "starts": null, "ends": "2019-12-13T06:00:00Z", "ageRequirement": 18, "otherRequirements": "Can lift heavy things", "functions": ["LANGUAGES", "MENTOR_TUTOR", "PUBLIC_SPEAKING"], "areasOfFocus": ["IMMIGRANTS_OR_REFUGEES", "LEGAL_ASSISTANCE"], "url": { "en": "https://www.idealist.org/en/volunter-opportunity/...", "es": "https://www.idealist.org/es/oportunidad-voluntariado/...", "pt": "https://www.idealist.org/pt/oportunidade-voluntariado/..." } } } ``` For the complete list of volunteer `functions`, see https://www.idealist.org/api/v1/volop-functions. For the complete list of `areasOfFocus`, see https://www.idealist.org/api/v1/areas-of-focus. Note that Volunteer listing details are subject to change. For example, `isCovid` will hopefully become obsolete soon. ## API Reference - Status Codes The API will return the following HTTP status codes: - 200 OK - 302 Found - if you are being redirected to /login, make sure that you are passing `Accept: application/json` - 401 Unauthorized - check your API token - 404 Not Found - It can mean a job has expired, has been hidden, etc. Otherwise, make sure the URL is correct. ## Changelog - 2025-04-25 Add links to volunteer functions and areas of focus. - 2025-04-20 Reformat code examples. - 2025-02-25 Added `welcomeTeens`, `welcomeAge55Plus`, `welcomePrivateCorpGroups`, `orientationRequired`, `backgroundCheckRequired`, `driversLicenseRequired`, `ageRequirement`, `otherRequirements` to volop. - 2025-02-25 Added `areasOfFocus` to jobs and volops. - 2025-02-14 Remove `isFullTime` filter. - 2024-06-11 Added `salaryCurrency`, `salaryPeriod` and `endDate`. - 2023-12-06 Added `applyOnIdealist`. - 2022-10-10 Remove `remoteOk` and `remoteTemporary`, to replace it with `locationType`. - 2022-08-17 Added `includeUnpublished`. Removed `groups` from `volops`. - 2022-02-08 Added `address.full` and more details about `org`. - 2021-10-08 Added `remoteZone`, `remoteCountry`, and `remoteTemporaryCovid` to api examples. - 2021-09-05 Added org urls and logos. - 2020-08-11 Added Volunteer listings. - 2019-07-23 Initial version.