Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Candid Lookup API

Operations for retrieving lookup values and filter metadata.

Candid Lookup API is one of 9 APIs that Candid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lookup. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v4.

Requests are made against a single base URL, https://api.candid.org/essentials.

3 operations 3 paths 3 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4
Base URL
https://api.candid.org/essentials
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Candid Lookup API declares 1 security scheme for authenticating requests. An API key is passed in the header as Subscription-Key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Candid subscription key required to call the Essentials API.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Lookup 3

Operations for retrieving lookup values and filter metadata.

GET
/lookup
List Lookup Filters
listLookupFilters → 200
GET
/lookup/{filter_name}
Get Lookup Values for Filter
getLookupByFilter 1 param → 200404
GET
/lookup/{filter_name}/{key_or_value}
Get Lookup Detail
getLookupByFilterAndKey 2 params → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.

LookupListResponse
object
A response wrapping a list of lookup items.
Error
object
Generic error response.
2 properties
LookupItem
object
A single lookup item record.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-lookup-api-openapi.yml Raw ↑

Other APIs Candid publishes across the network.

Candid Premier API
Candid Charity Check API
Candid Demographics API
Candid Grants API
Candid News API
Candid Taxonomy API
Candid Nonprofit Eligibility API
Candid Search API