v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB

/essentials/v4

Enhanced search with additional features and improved performance.

post/v4

Request body

search_termsstring

Can be any string you'd like to search on, including EIN, organization name, keywords, etc.

frominteger

The offset from the first result. Defaults to 0.

sizeinteger

The maximum number of hits to be returned. Defaults to 25. The maximum number allowed is 25.

Example request

{
  "search_terms": "candid",
  "size": 25,
  "sort": {
    "sort_by": "organization_name",
    "sort_order": "asc"
  },
  "filters": {
    "geography": {
      "state": [
        "NY"
      ],
      "radius": 50,
      "msa": [
        "NY-NJ"
      ],
      "city": [
        "New York"
      ],
      "county": [
        "New York, NY"
      ]
    },
    "organization": {
      "profile_levels": [
        "platinum"
      ],
      "subject_codes": [
        "SN04"
      ],
      "population_served_codes": [
        "PG0302"
      ],
      "ntee_major_codes": [
        "T"
      ],
      "ntee_minor_codes": [
        "50"
      ],
      "subsection_codes": [
        "501(c)(3) Public Charity"
      ],
      "foundation_codes": [
        "15"
      ],
      "group_exemption": [
        "9334"
      ],
      "number_of_employees": {
        "min": 5,
        "max": 987654321
      },
      "ruling_year": {
        "min": 5,
        "max": 987654321
      },
      "properties": {
        "bmf_status": true,
        "pub78_verified": true,
        "allow_online_giving": true,
        "relationship_type": {
          "independent": true
        }
      }
    },
    "financials": {
      "most_recent_year": {
        "form_types": {
          "f990": true,
          "f990ez": true
        },
        "total_revenue": {
          "min": 5,
          "max": 987654321
        },
        "total_expenses": {
          "min": 5,
          "max": 987654321
        },
        "total_assets": {
          "min": 5,
          "max": 987654321
        }
      }
    },
    "last_updated": {
      "start_date": "2020-01-01T01:01:01:01",
      "end_date": "2020-01-01T01:01:01:01",
      "date_type": "seal_last_modified"
    }
  }
}

Response

codeinteger

Response Code

messagestring

Diagnostic message for response status

tookinteger

Time taken for request to process

timestring

Time of API call.

results_countinteger

Number of results returned by search

page_countinteger

Number of pages returned by the search.

errorsstring[]

List of errors encountered

Example response

{
  "code": 200,
  "message": "Request was processed successfully!",
  "took": 24,
  "time": "2020-01-01T01:01:01:01.000Z",
  "results_count": 2541,
  "page_count": 67,
  "hits": [
    {
      "organization": {
        "candid_entity_id": "6908122",
        "organization_id": "7578046",
        "ein": "39-1731296",
        "organization_name": "Candid",
        "also_known_as": "Foundation Center, Guidestar",
        "group_exemption": "3297",
        "mission": "Get you the information to do good",
        "website_url": "candid.org",
        "logo_url": "candid.org",
        "donation_page": "https://candid.org/about/funding-candid",
        "profile_level": "Platinum",
        "profile_year": 2020,
        "profile_link": "https://www.guidestar.org/profile/82-4267025",
        "profile_logo": "https://www.guidestar.org/App_Themes/MainSite2/images/ProfilePageSvgs/profile-PLATINUM2021-seal.svg",
        "leader_name": "Ann Mei Chang",
        "leader_title": "CEO",
        "contact_name": "John smith",
        "contact_email": "help@orgnam.org",
        "contact_phone": "(555) 111-5555",
        "contact_title": "Support lead",
        "number_of_employees": 55,
        "ruling_year": 2019
      },
      "properties": {
        "allow_online_giving": true,
        "relationship_type": {
          "parent": true,
          "headquarters": true
        }
      },
      "geography": {
        "address_line_1": "1 Financial Sq",
        "address_line_2": "Floor 24",
        "city": "New York",
        "state": "NY",
        "zip": 10005,
        "msa": "IL - Peoria-Pekin",
        "congressional_district": "District 45, CA",
        "county": "Peoria, IL",
        "latitude": 40.9052,
        "longitude": -89.5866
      },
      "taxonomies": {
        "subject_codes": [
          {
            "subject_code": "SP030000",
            "subject_code_description": "SP030000"
          }
        ],
        "population_served_codes": [
          {
            "population_served_code": "PG030000",
            "population_served_description": "People with Physical Disabilities  "
          }
        ],
        "ntee_codes": [
          {
            "ntee_code": "A00",
            "ntee_code_description": "Humanities"
          }
        ],
        "subsection_code": {
          "subsection_code": "03",
          "subsection_code_description": "501(c)(3) Public Charity"
        },
        "foundation_code": {
          "foundation_code": "15",
          "foundation_code_description": "50% tax deductible"
        }
      },
      "financials": {
        "most_recent_year": {
          "form_types": "990",
          "fiscal_year": 2020,
          "total_revenue": 2349999,
          "total_expenses": 22224499,
          "total_assets": 57426592
        },
        "bmf_gross_receipts": 2349999,
        "bmf_assets": 1849900
      },
      "dates": {
        "seal_last_modified": "2020-01-01T01:01:01:01.000Z",
        "profile_last_modified": "2020-01-01T01:01:01:01.000Z",
        "dei_last_modified": "2020-01-01T01:01:01:01.000Z",
        "financials_last_modified": "2020-01-01T01:01:01:01.000Z",
        "last_modified": "2020-01-01T01:01:01:01.000Z"
      }
    }
  ]
}