/v2/developers/searchSearch developers
search:readv2 of GET /v1/developers/search. One thin YAML v2 query, as JSON or application/yaml: filters (facts), rank_by (ANN for meaning, BM25 for jargon, field order, score expressions), up to 8 lanes under queries fused by person, name sugar ({place|company|school: [...]}, metros by default), seeds ({like}, {repos_of}), repos, sort, rerank (none, rules, clef, jev). Results are the v1 developer shape at depth (core, enriched, deep) with evidence and the index card. At core (no facets) the page is read from the index alone: details holds the GitHub profile, top repos and devRank, and hasEmail is null. cursor pages. facets adds à-la-carte facet keys on top of depth, resolved at every depth, core included: identity.linkedin, contact.socials, contact.emails, tags.repos, ai.match_rationale. Any other key is a 400. ai.match_rationale (why a person matches the query) is a named add-on here. The AI summaries (ai.person_summary, ai.repo_summaries) are not served here: naming one in facets is a 400. Request them for the ids a page returns on GET /v2/developers/summaries, or with facets on GET /v2/developers/enrich. They are written in the background, so a first read can answer pending with retryAfterMs; the price is under addOns in GET /v2/pricing/catalog. Billed 1 credit per developer returned, plus each facet cell delivered for that developer: depth is a bundle of facet cells (core, enriched, deep, each a superset of the last) and facets adds more. A cell you already own bills 0. Price a request before sending it from the free GET /v2/pricing/catalog (skus, facets, and the depth tiers under bundles). The x-cost response header is what the call cost, and GET /v1/account/credits reads the balance. Which fields a query may use, and for what (filter, sort, boost, include), is listed live by GET /v2/developers/fields; a disabled field, or a use its flags refuse, is a 400.
Request body DeveloperQuery
versionnumber default: 1Optional here: 1.
1askstringThe ask in words; the re-rank reads it.
max 2000 charsfiltersone ofA filter: `[field, Op, value]`, `[And|Or, [...]]` or `[Not, f]`.
rank_byone ofHow to rank: by meaning (`[v, ANN, [Embed, text]]`, a vector, or `{like: [...]}`), exact nearest neighbours (`kNN`: a vector or `{like}`; pair it with filters), keywords (`BM25`, options as a 4th element), field order (up to 8 keys), or a score expression.
limitone ofSingle lane: a number counts people (1 to 1000); `{total, per}` counts rows. With queries: people.
includearray of stringmax 50 itemscomputeanyqueriesarray of DevsLane2 or more lanes (3 by default), fused by person. Top-level `filters` are ANDed into every lane; `rank_by`, `include` and `compute` go inside each lane.
min 2 items, max 32 itemsfiltersone ofA filter: `[field, Op, value]`, `[And|Or, [...]]` or `[Not, f]`.
rank_byone ofHow to rank: by meaning (`[v, ANN, [Embed, text]]`, a vector, or `{like: [...]}`), exact nearest neighbours (`kNN`: a vector or `{like}`; pair it with filters), keywords (`BM25`, options as a 4th element), field order (up to 8 keys), or a score expression.
limitone ofRows: a number, or `{total, per}` (per = rows per person, 1 to 5, default 3).
includearray of stringmax 50 itemscomputeany
fuseone ofrerankstringnone, rules (default when the query has text), clef or jev.
nonerulesclefjevsortstringrelevance (default) or a person field, highest first. With no text and no rank_by the index sorts by it; otherwise the people found are re-ordered by it (nulls last). recent = last_active_at (GH Archive, partial).
relevancedevrankstarsfollowersrecentconsistencystringeventual (default; the index is written in batches) or strong (every write before the query).
eventualstrongreposobjectPeople who own and/or contributed to 1 to 10 repos (owner/name), combined with every other filter, text and sort.
namesarray of string requiredmin 1 items, max 10 itemsrolestring default: "either"owner, contributor, or either (default).
ownercontributoreitherhopsone of1: the people on the repos; 2: worked with them (people who share another repo with them, members excluded).
judgeobjectclef / jev: how many of the rules top the model scores (default 20) and the per-call cap (default 900 ms).
topintegermin 1, max 30timeout_msintegermin 100, max 3000
depthstring default: "core"The depth ladder: core (the default), enriched, deep. Each step returns more of the profile. Deep adds the contribution garden only when `garden` is sent; without it deep is enriched.
coreenricheddeepfacetsarray of string default: []À-la-carte facet keys on top of the depth tier, resolved at every depth (core included): `identity.linkedin`, `contact.socials`, `contact.emails`, `tags.repos` or `ai.match_rationale` (judged against the query). A depth tier name (`core`, `enriched`, `deep`) is also accepted. Anything else is a 400. The AI summaries (`ai.person_summary`, `ai.repo_summaries`) are sold on GET /v2/developers/summaries and GET /v2/developers/enrich only: naming one here is a 400.
max 5 itemsgardenone ofOpt in to each developer’s contribution garden. Off unless sent: a garden is a GitHub read and a large block for an agent to carry. `true` or `summary` returns the compact `gardenSummary` (totals, active days and weeks, the last 90 days, per-month counts); `full` returns the whole daily `garden`, for drawing a heatmap.
repoLimitinteger default: 4min 1, max 12cursorstringThe previous page’s `cursor`: the next people for the same query.
max 16384 charsexcludearray of stringDeveloper ids never to return (up to 1000), e.g. people you already hold.
max 1000 itemsinclude_thin_profilesbooleantrue also returns profiles whose profile_quality is empty (no email, no profile README, no recent activity and little else to go on) or bot, which search and similar hide by default. Thin profiles are always returned.
Responses
200Developers with evidence and their index cardresultsarray of DeveloperV2 requiredBest match first, in the v1 developer shape.
idstring requiredThe stable GitHub numeric id for this developer. Immutable (unlike the login) — this is the handle to pass to every other endpoint.
max 64 charsloginstring requiredThe GitHub handle as of the last snapshot. Display it, do not key on it: handles are renameable and reusable.
max 200 charsnamestring | null requiredDisplay name as the developer set it on GitHub. Null when they set none.
max 200 charsavatarUrlstring | null requiredGitHub avatar image URL. Null when absent.
max 2048 charshasEmailboolean requiredWhether we hold at least one email address for this developer. It says we have an address on file, not that the address works — we do not check deliverability. The addresses themselves are never returned by a search or a base profile read: this boolean is the free signal, and the paid `contact.emails` facet is the only way to get them. Use `hasEmail` on a search request to filter to developers we hold an address for, without paying.
hasLinkedinboolean requiredWhether we hold a LinkedIn match for this developer — i.e. whether `enriched` will return `identity.*` and `contact.socials` for them. Available on the same base row as `hasEmail`: read both to decide what depth is worth requesting.
hasLocationboolean requiredWhether we hold any resolved location for this developer (from LinkedIn or a geocoded GitHub string). A free presence flag alongside `hasEmail`/`hasLinkedin`. The resolved `location` OBJECT rides `details.contact.location` at `enriched` (like the LinkedIn URL), not on the spine. Filter on it with `requireLocation=true`.
detailsPublicDetails requiredEvery detail about this developer beyond the identity spine, as a KEYED object grouped by section. A section and its members appear only when resolved; absent details are omitted entirely. The set grows with depth: `core` fills `githubProfile.*` and `score.cracked`; `enriched` adds `identity.*`, `contact.socials` and `contact.location`; `deep` adds `github.garden`. À-la-carte: `tags.repos` folds onto `githubProfile.repos[]`, the emails route fills `contact.emails`.
githubProfileobjectThe free GitHub profile: `githubProfile.core` (bio, org, languages, snapshot counts) and `githubProfile.repos`. Named for its source — everything here comes straight from GitHub.
coreobjectbio, currentRole, organization, university, languages, joinedAt, followers, following, totalStars.
reposarray of ProfileRepoWithTagsTop repositories (default 4), with `owned`/`commits` and, when resolved, `subjects`/`technologies` (`tags.repos`) and a plain-English `summary`/`themes` (`ai.repo_summaries`) folded on. The full set of blurbs is also on `details.ai.repo_summaries.value`.
namestring requiredThe repository name alone, without the owner (`linux`).
max 200 charsfullNamestring requiredGitHub `owner/name`. This is the join key: an evidence repo and a profile repo describing the same repository carry the same `fullName`.
max 200 charsdescriptionstring | null requiredThe repository's own GitHub description, verbatim. Null when it has none.
max 5000 charslanguagestring | null requiredGitHub's primary language for the repository. Null when GitHub reports none (an empty or docs-only repo); never inferred from the code.
max 200 charsstarsinteger requiredStargazer count at the time this profile was snapshotted, not at request time.
min 0, max 100000000commitsintegerHow many commits THIS developer authored to this repository over the trailing year. This is the difference between a project they wrote and a project they landed one drive-by fix in — a 385k-star repository with 4 of their commits is not their work. Absent when no commit signal was captured; 0 means none in the trailing year, which for older dormant work is not the same as none ever.
min 0, max 100000000ownedbooleanTrue when the repository sits under the developer's own account, false when it is someone else's (an organisation's or another person's) and they are a contributor to it. This is the difference between "they built this" and "they committed to this", and it is the ONLY honest basis for crediting a repository's stars to a person. Absent when no ownership signal was captured; treat absent as unknown, never as false.
urlstring requiredThe public github.com URL of the repository.
max 2048 charssubjectsarray of stringSubject/domain tags for this repository. Present only when `tags.repos` was resolved and this repo carried tags.
technologiesarray of stringTechnology tags for this repository. Present only when `tags.repos` was resolved and this repo carried tags.
summarystringA one-line, plain-English blurb on what this repository is, written for a non-technical reader. Present only when `ai.repo_summaries` was resolved and the model could describe this repo. Folded onto the repos shown here; `details.ai.repo_summaries.value.repoSummaries` lists every repository that was summarized, including ones past `repoLimit`.
themesarray of stringA few short themes the AI drew from this repository. Present alongside `summary` when `ai.repo_summaries` was resolved.
scoreobjectThe cracked score (`score.cracked`).
crackedobjectcrackedScore, tier.
identityobjectThe resolved external identity (`enriched`): `identity.linkedin`, `identity.experience`, `identity.education`.
linkedinobjectThe resolved LinkedIn identity scalars (linkedin, headline, title, company, seniority, expertise, location).
experiencearray of objectEmployment history, newest first. Present only when non-empty.
titlestring | nullJob title.
max 200 charscompanystring | nullEmployer name.
max 200 charsstartDatestring | nullStart date exactly as the source rendered it. Free text, not normalised.
max 200 charsendDatestring | nullEnd date, same unnormalised free-text form. Null on a current role.
max 200 charscurrentboolean | nullThe source's own "still there" flag.
educationarray of objectEducation history, in the order the source listed it. Present only when non-empty. Entries are not ordered by level and can include secondary schools, so read every entry when confirming a university or a graduation year.
schoolstring | nullInstitution name.
max 200 charsdegreestring | nullDegree awarded.
max 200 charsfieldOfStudystring | nullField of study.
max 200 charsstartDatestring | nullStart date as the source rendered it.
max 200 charsendDatestring | nullEnd date as the source rendered it.
max 200 chars
contactobjectContact channels: `contact.socials` (enriched), `contact.location` (enriched), `contact.emails` (the emails route).
socialsobjectgithub, linkedin social links.
emailsarray of stringEvery address we observe for this developer, ranked, the best one first. Present only when we hold at least one, resolved via the emails route.
bestEmailstring | nullThe address to use: the first unflagged personal address, else the first unflagged one; null when every address is flagged. On v2 only.
emailDetailsarray of objectEvery address with its type and flags, ranked, the most reliable first; within a source, personal, then work, then other. On v2 only.
addressstring requiredtypestring requiredpersonal: a free-mail or own-name domain; work: a company domain; other: academic or government.
personalworkotherflagsarray of string requiredWhy it may not reach this person. `name_mismatch`: it names neither their current name nor their login (a prior name, or someone else). `low_link_confidence`: it came through a LinkedIn link we are not sure of. `ambiguous_link`: they map to several LinkedIn profiles. Flagged addresses are kept, never dropped.
locationobject | nullWhere this developer is, resolved once and LinkedIn-preferred: `source` says whether the clean city/country came from their LinkedIn (`linkedin`) or from geocoding their GitHub location string (`github`). Present at `enriched`+ whenever `hasLocation` is true — the spine carries only the `hasLocation` flag. Note the GitHub geocode is rough (it often drops a country string into `city`); trust `source: "linkedin"` over `"github"`.
rawstring | null requiredThe location string exactly as the developer typed it on GitHub ("SF / remote").
max 200 charscitystring | null requiredCity resolved from `raw` by geocoding. Null when `raw` was empty or unresolvable.
max 200 charsstatestring | nullThe country subdivision (US state, province, region) as a full name, e.g. "Ohio". Present only from the clean LinkedIn overlay, for the developers we hold a match for. Absent otherwise: the GitHub geocoder does not reliably resolve it (so we do not surface its guess), and it is legitimately absent for city-states and metro-only profiles.
max 200 charscountrystring | null requiredCountry resolved from `raw`. Null when `raw` was empty or unresolvable. It can also be null while `city` is set, so read `city` and `raw` beside it before treating a location as unknown.
max 200 charssourcestringWhere the resolved city/country came from: `linkedin` when our LinkedIn overlay supplied it (clean, self-reported on LinkedIn), `github` when it is geocoded from the GitHub `raw` string. Most developers have no LinkedIn match, so `github` is the common case and its city/country are often sparse. Absent on unresolved payloads.
linkedingithub
githubobjectThe live-GitHub block (`deep`): `github.gardenSummary` by default, or the full `github.garden` with `garden=full`.
gardenobjectThe full contribution heatmap: every day’s count for the trailing year. Only with `garden=full`.
gardenSummaryGardenSummaryThe contribution garden as a compact read (the default `garden=summary`): totals, active days and weeks, the last 90 days, per-month counts.
fromstring requiredFirst day of the garden window, `YYYY-MM-DD`, inclusive.
tostring requiredLast day of the garden window, `YYYY-MM-DD`, inclusive.
totalinteger requiredPublic contributions across the window.
activeDaysinteger requiredDays in the window with at least one contribution.
activeWeeksinteger requiredDistinct weeks in the window with at least one contribution. Steady contributors score close to 52.
last90Daysinteger requiredContributions in the 90 days ending on `to`.
lastActiveDaystring | null requiredThe most recent day with a contribution, `YYYY-MM-DD`. Null when the window is empty.
byMonthobject requiredContributions per calendar month, `YYYY-MM` → count. Months with none are omitted.
fetchedAtstring requiredWhen the underlying garden was read from GitHub, as an ISO 8601 instant.
followersinteger | null requiredCurrent GitHub follower count, live. Null on older gardens.
totalStarsinteger | null requiredStars on repositories they OWN, live. Null on older gardens.
statusstringPresent only when the garden did not come back, in place of it: `pending` (being read, re-fetch after `retryAfterMs`), `failed` (the GitHub read errored; a retry can succeed), `unavailable` (no garden exists for this developer). None of the three is charged.
pendingfailedunavailableretryablebooleanWith `status`: whether re-fetching this call can return the garden.
retryAfterMsnumberWith `status: pending`: milliseconds to wait before re-fetching.
aiobjectÀ-la-carte AI prose. `person_summary`/`repo_summaries` come from the `/developers/summaries` route or `facets=ai.person_summary,ai.repo_summaries` on enrich, at every depth (never on the v2 search or similar). `match_rationale` comes from `facets=ai.match_rationale` on SEARCH, judged against your `q`. Compute is async, so each member carries a `status`: `ok` (the `value` is here), `pending` (with `retryAfterMs`: wait that long, then re-fetch this call once; the value is computed once, so a retry returns quickly), `failed` (with `retryable: true`: the write errored, and a re-fetch requests it again) or `unavailable` (with `retryable: true`: there is nothing to summarize yet, and a later read may return it). A member you asked for is never silently left out. A pending `person_summary`/`repo_summaries` can also be collected from `/developers/summaries` with the same ids: there, reading a developer is free while a summary your account has paid for is still being written, and for the one read that returns it finished. Read status before value.
person_summaryobjectA short pitch for this developer. On `ok`, `value` is `{ personSummary, headline, body? }`: `personSummary` is the whole pitch as one string of two lines, a headline (who they are across their career) over one or two plain sentences on the kind of work they do and their most notable projects. `headline` is the first line, ready to set as a title. `body` is the rest, absent when the pitch is one line.
statusstring required`ok`: `value` is here. `pending`: being written, re-fetch after `retryAfterMs`. `failed`: the write errored and a re-fetch requests it again. `unavailable`: there is nothing to summarize yet, and a later read may return it.
okpendingfailedunavailablevalueobjectOn `ok` only.
retryablebooleanOn `failed` and `unavailable`: whether re-fetching this call can return the value.
retryAfterMsnumberOn `pending` only: milliseconds to wait before re-fetching this call. The value is computed once, so a retry returns `ok` quickly once it lands.
repo_summariesobjectThe per-repo AI blurbs. On `ok`, `value` is `{ repoSummaries: [{ fullName, blurb, themes? }] }`, one entry for every repository that was summarized (not only the ones `repoLimit` shows). The same blurbs also fold onto `githubProfile.repos[].summary`/`.themes` for the repos shown.
statusstring required`ok`: `value` is here. `pending`: being written, re-fetch after `retryAfterMs`. `failed`: the write errored and a re-fetch requests it again. `unavailable`: there is nothing to summarize yet, and a later read may return it.
okpendingfailedunavailablevalueobjectOn `ok` only.
retryablebooleanOn `failed` and `unavailable`: whether re-fetching this call can return the value.
retryAfterMsnumberOn `pending` only: milliseconds to wait before re-fetching this call. The value is computed once, so a retry returns `ok` quickly once it lands.
match_rationaleobjectWhether and why this developer matches the search query, judged against it. SEARCH ONLY (there is no query to judge against on an id lookup). `value` is `{ matched, reasons? }`: a real match is `{ matched: true, reasons: ["Currently Staff Engineer at Stripe on payments", "Maintains a Go ISO-20022 library", "8 years shipping Go"] }` — a list of short, positive, recruiter-facing bullets (repos, languages, LinkedIn role/company, organisation, location, tenure). A weak/non-match is `{ matched: false }` (no reasons — an honest verdict, not a manufactured one). Check `matched` before reading `reasons`.
statusstring required`ok`: `value` is here. `pending`: being written, re-fetch after `retryAfterMs`. `failed`: the write errored and a re-fetch requests it again. `unavailable`: there is nothing to summarize yet, and a later read may return it.
okpendingfailedunavailablevalueobjectOn `ok` only.
retryablebooleanOn `failed` and `unavailable`: whether re-fetching this call can return the value.
retryAfterMsnumberOn `pending` only: milliseconds to wait before re-fetching this call. The value is computed once, so a retry returns `ok` quickly once it lands.
matchDeveloperMatch requiredQuery attribution for this result: the matched repositories and whether the lane could attribute at all.
reposarray of MatchRepo requiredThe repositories that connect this developer to your query. Empty whenever `status` is `unattributed`.
max 12 itemsfullNamestring requiredGitHub `owner/name`. The join key onto `developer.repos[].fullName`, so you can match an evidence repo back to the profile repo it refers to.
max 160 charsstarsinteger requiredStargazer count at retrieval time. 0 also means "the source returned no count", so do not read 0 as proof the repo is unstarred.
min 0, max 100000000languagestring | nullGitHub’s primary language for the repository. Null when none was returned; never inferred from the code. Absent on pages produced before this field existed.
max 200 charsrolestring | nullThis person’s relationship to the repository, and it is deliberately conservative. `owner` means the repository sits under THEIR account. `contributor` means everything else, including the person who wrote most of the code in someone else’s or an organisation’s repository — a top committer on a company repo is a `contributor`, so do not read `contributor` as "minor" or `owner` as "wrote it". Null means the lane that produced this row genuinely cannot tell; absent means an older producer did not emit the field.
ownercontributor
statusstring requiredWhether `repos` genuinely answers "why did this person come back for my query". `attributed` = it does. `unattributed` = the lane that answered cannot attribute repositories to the query, and `repos` is empty.
attributedunattributed
hasEmailboolean | nullnull at depth core: the index card does not carry it. enriched and deep read it.
evidenceDevsEvidence requiredmatchesarray of object requiredkindstring requiredprofilereporolesimilaritynumber | null requiredHow close this row is to the query, 0 to 1; null when the row matched on a filter or keywords.
rerankobject requiredThe re-rank that ordered this person: `mode`, plus `status` (scored, skipped or timeout) and `reason` when the model re-rank fell back to rules.
modestring requirednonerulesclefjev
similaritynumber | null requiredThe best match similarity, 0 to 1; null when nothing scored the person (a filter or field order).
sortobjectThe field values that placed this person when the query sorts by fields, e.g. `{devrank: 91}`.
hopinteger/v2/developers/similar: 1 = like the person directly, 2 or more = reached by `widen` through the people they work with.
indexobject requiredThe index card the search ran on: profile, top_repos, recent_roles.
profileobject | null requiredtop_reposarray of object requiredrecent_rolesarray of object
cursorstring | null requiredSend it back as `cursor` with the same query for the next page; null at the end.
countStatusone of requiredcachedboolean requiredrerank_appliedstring requirednonerulesclefjevrerank_skippedstring | null requiredrerank_judgedobject | null requiredscoredinteger requiredofinteger required
filters_appliedarray of object requiredlanenumber requiredattrstring requiredopstring requiredvalueany
ids_resolvedobject requiredplaces_resolvedarray of object requiredEach place that is a metro core city: the scope it ran with, its metro and how many city ids it filtered on.
placestring requiredscopestring requiredmetrocitymetrostring requiredmember_countinteger required
not_livearray of string requiredFields this request used whose data is still filling in. Each is still applied exactly as sent: people whose value is missing or wrong can be left out.
normalizer_versionstring requiredtimingsobject requiredwarningsarray of objectPresent only when the query used a field with a caveat, e.g. a filter on a field that holds no data yet (it matches nobody). GET /v2/developers/fields lists the fields a request can use.
fieldstring requiredstatusstring requiredmessagestring required
gardens_pendingarray of string requiredWith `garden` sent: returned developers whose contribution garden is not held yet. It is being read now, so POST /v2/developers/gardens with these ids a few seconds later returns it. Always empty without `garden`.
400The query does not compile; `hint` says what to changeokboolean requiredfalseerrorstring requiredhintstring requiredcodestringWhy the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...
bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabledrequestIdstringQuote it when reporting a failure
retryAfterMsintegerWait this long before retrying (also Retry-After, in seconds)
401Missing or invalid API keycodestring requiredStable machine-readable error code. Branch on this, never on the numeric status.
bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.
topupconnect_mailboxbook_callcheckouturlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
402Your plan does not include this capabilitycodestring requiredStable machine-readable error code. Branch on this, never on the numeric status.
bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.
topupconnect_mailboxbook_callcheckouturlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
403The key lacks search:readcodestring requiredStable machine-readable error code. Branch on this, never on the numeric status.
bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_errorbuild_failedself_serve_checkout_disabledwork_email_requiredtrial_unavailablecheckout_pendingchange_email_not_allowedmessagestring requiredHuman-readable explanation of the refusal.
statusinteger requiredThe HTTP status code, repeated in the body.
remedyobjectA self-serve path forward, when one exists (a 402 points at how to restore access).
kindstring requiredWhat kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.
topupconnect_mailboxbook_callcheckouturlstring requiredWhere to go to clear the condition: an API path, or a web app page when only a person can.
404The seed is not in the indexokboolean requiredfalseerrorstring requiredhintstring requiredcodestringWhy the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...
bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabledrequestIdstringQuote it when reporting a failure
retryAfterMsintegerWait this long before retrying (also Retry-After, in seconds)
429Rate limit (10 requests per second per key), or the index is busy; see Retry-Afterokboolean requiredfalseerrorstring requiredhintstring requiredcodestringWhy the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...
bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabledrequestIdstringQuote it when reporting a failure
retryAfterMsintegerWait this long before retrying (also Retry-After, in seconds)
503Search is not enabled in this environment, or the index is unavailable; see Retry-Afterokboolean requiredfalseerrorstring requiredhintstring requiredcodestringWhy the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...
bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabledrequestIdstringQuote it when reporting a failure
retryAfterMsintegerWait this long before retrying (also Retry-After, in seconds)
504The index did not answer in time; retry, and see Retry-Afterokboolean requiredfalseerrorstring requiredhintstring requiredcodestringWhy the index failed: index_busy, too_many_in_flight, engine_timeout, upstream_failed, ...
bad_requestnot_foundindex_busytoo_many_in_flightengine_timeoutupstream_failednot_enabledrequestIdstringQuote it when reporting a failure
retryAfterMsintegerWait this long before retrying (also Retry-After, in seconds)