Search a population

POST

populations

Search a population

curl --request POST \
  --url https://api.orbitsearch.com/v3/search/populations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "population": {
    "id": "<string>",
    "name": "<string>"
  },
  "request_id": "<string>",
  "size": 1,
  "profile_depth": "partial"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    population: {id: '<string>', name: '<string>'},
    request_id: '<string>',
    size: 1,
    profile_depth: 'partial'
  })
};

fetch('https://api.orbitsearch.com/v3/search/populations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/search/populations"

payload = {
    "population": {
        "id": "<string>",
        "name": "<string>"
    },
    "request_id": "<string>",
    "size": 1,
    "profile_depth": "partial"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "search_id": "<string>",
  "request_id": "<string>",
  "status": "running",
  "candidate_discovery": true,
  "profile_depth": "partial",
  "include_profile": true,
  "profile_upgrades_completed": true,
  "results": [
    {
      "profile_id": "<string>",
      "status": "generating",
      "generation_level": 2,
      "sources": [
        "search"
      ],
      "candidate_sources": [
        {
          "link": "<string>",
          "title": "<string>",
          "sourceImage": "<string>"
        }
      ],
      "preview": {},
      "profile": {
        "id": "<unknown>",
        "generationLevel": "<unknown>",
        "avatarUrl": "<unknown>",
        "verified": "<unknown>",
        "sections": {
          "socials": {
            "items": [
              {}
            ]
          },
          "bio": {
            "bio": "<string>"
          },
          "basic": {
            "items": [
              {}
            ]
          },
          "personalLife": {
            "items": [
              {}
            ]
          },
          "jobs": {
            "items": [
              {}
            ]
          },
          "education": {
            "items": [
              {}
            ]
          },
          "passions": {
            "items": [
              {}
            ]
          },
          "worldview": {
            "items": [
              {}
            ]
          },
          "accomplishments": {
            "items": [
              {}
            ]
          },
          "controversies": {
            "items": [
              {}
            ]
          },
          "bestQualities": {
            "items": [
              {}
            ]
          },
          "netWorth": {
            "items": [
              {}
            ]
          },
          "eventsTimeline": {
            "items": [
              {}
            ]
          },
          "portfolio": {
            "items": [
              {}
            ]
          },
          "families": {
            "items": [
              {}
            ]
          },
          "researchPapers": {
            "items": [
              {}
            ]
          },
          "githubRepos": {
            "items": [
              {}
            ]
          },
          "mediaCredits": {
            "items": [
              {}
            ]
          },
          "musicCredits": {
            "items": [
              {}
            ]
          },
          "books": {
            "items": [
              {}
            ]
          }
        },
        "displayName": "<unknown>",
        "personName": "<unknown>",
        "aliases": "<unknown>",
        "profileUrl": "<unknown>",
        "slug": "<unknown>",
        "category": "<unknown>",
        "location": "<unknown>",
        "headline": "<unknown>",
        "emails": "<unknown>",
        "emailDetails": [
          {
            "email": "jsmith@example.com",
            "type": "personal",
            "typeBasis": "consumer_domain",
            "verification": {
              "status": "deliverable",
              "verifiedAt": "2023-11-07T05:31:56Z",
              "catchAllDomain": true
            },
            "employer": {
              "association": "current",
              "companyName": "<string>",
              "companyDomain": "<string>"
            }
          }
        ],
        "employmentDomains": [
          {
            "isCurrent": true,
            "companyName": "<string>",
            "domain": "<string>"
          }
        ],
        "phoneNumbers": "<unknown>",
        "phoneDetails": [
          {
            "phoneNumber": "<string>",
            "type": "mobile",
            "isConnected": true,
            "firstReported": 123,
            "lastReported": 123
          }
        ],
        "addresses": "<unknown>"
      },
      "failure": {
        "code": "<string>",
        "message": "<string>",
        "retryable": true,
        "reason": "<string>",
        "suggested_inputs": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "links": {
    "status": "<string>"
  },
  "candidate_discovery_completed": true,
  "provider_results_final": true,
  "discovered_sources": [
    {
      "link": "<string>",
      "title": "<string>",
      "sourceImage": "<string>"
    }
  ],
  "candidate_discovery_failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "population": {
    "kind": "company",
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "profile_depth": "partial",
    "credits_quoted": 123,
    "status": "running"
  },
  "query_intent": {
    "organizations": [
      "<string>"
    ],
    "schools": [
      "<string>"
    ],
    "person_named": true
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "search_id": "<string>",
  "request_id": "<string>",
  "status": "running",
  "candidate_discovery": true,
  "profile_depth": "partial",
  "include_profile": true,
  "profile_upgrades_completed": true,
  "results": [
    {
      "profile_id": "<string>",
      "status": "generating",
      "generation_level": 2,
      "sources": [
        "search"
      ],
      "candidate_sources": [
        {
          "link": "<string>",
          "title": "<string>",
          "sourceImage": "<string>"
        }
      ],
      "preview": {},
      "profile": {
        "id": "<unknown>",
        "generationLevel": "<unknown>",
        "avatarUrl": "<unknown>",
        "verified": "<unknown>",
        "sections": {
          "socials": {
            "items": [
              {}
            ]
          },
          "bio": {
            "bio": "<string>"
          },
          "basic": {
            "items": [
              {}
            ]
          },
          "personalLife": {
            "items": [
              {}
            ]
          },
          "jobs": {
            "items": [
              {}
            ]
          },
          "education": {
            "items": [
              {}
            ]
          },
          "passions": {
            "items": [
              {}
            ]
          },
          "worldview": {
            "items": [
              {}
            ]
          },
          "accomplishments": {
            "items": [
              {}
            ]
          },
          "controversies": {
            "items": [
              {}
            ]
          },
          "bestQualities": {
            "items": [
              {}
            ]
          },
          "netWorth": {
            "items": [
              {}
            ]
          },
          "eventsTimeline": {
            "items": [
              {}
            ]
          },
          "portfolio": {
            "items": [
              {}
            ]
          },
          "families": {
            "items": [
              {}
            ]
          },
          "researchPapers": {
            "items": [
              {}
            ]
          },
          "githubRepos": {
            "items": [
              {}
            ]
          },
          "mediaCredits": {
            "items": [
              {}
            ]
          },
          "musicCredits": {
            "items": [
              {}
            ]
          },
          "books": {
            "items": [
              {}
            ]
          }
        },
        "displayName": "<unknown>",
        "personName": "<unknown>",
        "aliases": "<unknown>",
        "profileUrl": "<unknown>",
        "slug": "<unknown>",
        "category": "<unknown>",
        "location": "<unknown>",
        "headline": "<unknown>",
        "emails": "<unknown>",
        "emailDetails": [
          {
            "email": "jsmith@example.com",
            "type": "personal",
            "typeBasis": "consumer_domain",
            "verification": {
              "status": "deliverable",
              "verifiedAt": "2023-11-07T05:31:56Z",
              "catchAllDomain": true
            },
            "employer": {
              "association": "current",
              "companyName": "<string>",
              "companyDomain": "<string>"
            }
          }
        ],
        "employmentDomains": [
          {
            "isCurrent": true,
            "companyName": "<string>",
            "domain": "<string>"
          }
        ],
        "phoneNumbers": "<unknown>",
        "phoneDetails": [
          {
            "phoneNumber": "<string>",
            "type": "mobile",
            "isConnected": true,
            "firstReported": 123,
            "lastReported": 123
          }
        ],
        "addresses": "<unknown>"
      },
      "failure": {
        "code": "<string>",
        "message": "<string>",
        "retryable": true,
        "reason": "<string>",
        "suggested_inputs": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "links": {
    "status": "<string>"
  },
  "candidate_discovery_completed": true,
  "provider_results_final": true,
  "discovered_sources": [
    {
      "link": "<string>",
      "title": "<string>",
      "sourceImage": "<string>"
    }
  ],
  "candidate_discovery_failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "population": {
    "kind": "company",
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "profile_depth": "partial",
    "credits_quoted": 123,
    "status": "running"
  },
  "query_intent": {
    "organizations": [
      "<string>"
    ],
    "schools": [
      "<string>"
    ],
    "person_named": true
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

A population search is a v3 search whose results are everyone in one population: every current employee of a company, or everyone who attended a school. The search adds people to its results as it finds them. Price the search first with Price a population. Starting it reserves the quoted credits.

curl -X POST "https://api.orbitsearch.com/v3/search/populations" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "a6c1c2f0-4d3e-4b0f-9b3e-2e2a5a4f1c11",
    "population": { "kind": "company", "id": "1441", "name": "OpenAI" },
    "size": 2400,
    "profile_depth": "partial"
  }'

Request body

Field	Type	Default	Description
`request_id`	string	generated	Idempotency key. The same `request_id` returns the same search; a different population under the same id returns `409`.
`population.kind`	`company` or `school`	—	What the population is.
`population.id`	string	—	The numeric id of the company or school.
`population.name`	string	—	The company or school name, 1–200 characters.
`size`	integer	`null`	How many people the population has, when you know it.
`profile_depth`	`partial` or `full`	`partial`	The depth every person in the population is built to. See Profile depth.

Response

The response is a search snapshot. Poll GET /v3/search/{search_id} while status is running; results are append-only, so every poll returns everyone found so far. Population searches use include_profile: false; read a profile with Read a profile. The snapshot carries a population block:

Field	Description
`kind`, `id`, `name`	The population’s subject.
`size`	The population’s size as given, or `null`.
`profile_depth`	The depth every person is built to.
`credits_quoted`	The credits reserved when the search started.
`status`	`running`, `completed`, `completed_with_errors`, `failed` or `cancelled`. The search’s own `status` is `completed_with_errors` when the population ends `failed` or `cancelled`.

The search completes when the whole population is in. A person who could not be built ends failed and the search ends completed_with_errors.

Billing

Orbit reserves the quoted credits when the search starts, settles them as the work completes, and releases what it did not use when the search ends. See Credits.

Rate limits

A population start spends the same rate-limit bucket as POST /v3/search. The quote spends the status bucket.

Authorizations

Authorization

string

header

required

Use an Orbit API key from the developer dashboard.

Headers

Idempotency-Key

string

A client-generated key for a safe retry. If the body omits request_id, Orbit can use this value as the request ID.

Maximum string length: 200

Body

application/json

population

object

required

Show child attributes

request_id

string

Idempotency key. The same request_id returns the same search; a different population under the same id returns 409.

Maximum string length: 200

size

integer | null

How many people the population has, when you know it.

Required range: x >= 0

profile_depth

enum<string>

default:partial

The depth every person in the population is built to.

Available options:

partial,

full

Response

The search completed at once.

search_id

string

required

Server-generated identifier for this search. Use it to poll the status endpoint.

request_id

string

required

The idempotency key from the original request, or a generated value when the request omitted it.

status

enum<string>

required

Overall search lifecycle. running means work is still in progress; poll until the status is terminal. completed means every result reached the requested profile depth; a search can complete with an empty results list when nothing matched. completed_with_errors means ready results are available but some work failed. failed means work failed and no ready results are available.

Available options:

running,

completed,

completed_with_errors,

failed

candidate_discovery

boolean

required

Whether this search runs candidate discovery, as resolved from the request.

profile_depth

enum<string>

required

The minimum profile depth requested for each ready result.

Available options:

partial,

full

include_profile

boolean

required

Whether readable results embed their Search profile.

profile_upgrades_completed

boolean

required

Whether every result in results has reached the requested profile_depth or failed. While candidate_discovery_completed is false, discovery can still add results with new profile work.

results

object[]

required

The people this search has found so far. Results are append-only: a reported result is never removed, and a ready result never regresses.

Show child attributes

created_at

string<date-time>

required

When the search was created.

updated_at

string<date-time>

required

When the snapshot last changed.

links

object

required

Show child attributes

candidate_discovery_completed

boolean

Whether the result list is final. Once true, discovery adds no more results to this search; the results themselves can still be generating or enriching toward the requested depth. For discovery searches this becomes true when clustering completes and every discovered person appears in results. If discovery failed, candidate_discovery_failure explains why. Present only when candidate_discovery is true.

provider_results_final

boolean

Whether the people-data provider lookup for a supplied phone, email, or address returned its complete owner set. Once true, every owner of that contact is in results with the contacts the provider reported, usually within the first response and before biography work. Discovery by name can still add results until candidate_discovery_completed is true. Present only when candidate_discovery is true and the request carried a phone, email, or address signal.

discovered_sources

object[]

Candidate Discovery source receipts that have not yet been assigned to a result. Present when candidate_discovery is true.

Show child attributes

candidate_discovery_failure

object

Why candidate discovery failed. Present only when discovery failed.

Show child attributes

population

object

Present on population searches: the subject, the depth, the reserved credits and where the search is.

Show child attributes

query_intent

object

Present when the search parsed a plain-English query.

Show child attributes

billing

object

Credits held and spent for this search. The final consumedCredits is the full charge once status is settled.

Show child attributes

Search a population

curl --request POST \
  --url https://api.orbitsearch.com/v3/search/populations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "population": {
    "id": "<string>",
    "name": "<string>"
  },
  "request_id": "<string>",
  "size": 1,
  "profile_depth": "partial"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    population: {id: '<string>', name: '<string>'},
    request_id: '<string>',
    size: 1,
    profile_depth: 'partial'
  })
};

fetch('https://api.orbitsearch.com/v3/search/populations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orbitsearch.com/v3/search/populations"

payload = {
    "population": {
        "id": "<string>",
        "name": "<string>"
    },
    "request_id": "<string>",
    "size": 1,
    "profile_depth": "partial"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "search_id": "<string>",
  "request_id": "<string>",
  "status": "running",
  "candidate_discovery": true,
  "profile_depth": "partial",
  "include_profile": true,
  "profile_upgrades_completed": true,
  "results": [
    {
      "profile_id": "<string>",
      "status": "generating",
      "generation_level": 2,
      "sources": [
        "search"
      ],
      "candidate_sources": [
        {
          "link": "<string>",
          "title": "<string>",
          "sourceImage": "<string>"
        }
      ],
      "preview": {},
      "profile": {
        "id": "<unknown>",
        "generationLevel": "<unknown>",
        "avatarUrl": "<unknown>",
        "verified": "<unknown>",
        "sections": {
          "socials": {
            "items": [
              {}
            ]
          },
          "bio": {
            "bio": "<string>"
          },
          "basic": {
            "items": [
              {}
            ]
          },
          "personalLife": {
            "items": [
              {}
            ]
          },
          "jobs": {
            "items": [
              {}
            ]
          },
          "education": {
            "items": [
              {}
            ]
          },
          "passions": {
            "items": [
              {}
            ]
          },
          "worldview": {
            "items": [
              {}
            ]
          },
          "accomplishments": {
            "items": [
              {}
            ]
          },
          "controversies": {
            "items": [
              {}
            ]
          },
          "bestQualities": {
            "items": [
              {}
            ]
          },
          "netWorth": {
            "items": [
              {}
            ]
          },
          "eventsTimeline": {
            "items": [
              {}
            ]
          },
          "portfolio": {
            "items": [
              {}
            ]
          },
          "families": {
            "items": [
              {}
            ]
          },
          "researchPapers": {
            "items": [
              {}
            ]
          },
          "githubRepos": {
            "items": [
              {}
            ]
          },
          "mediaCredits": {
            "items": [
              {}
            ]
          },
          "musicCredits": {
            "items": [
              {}
            ]
          },
          "books": {
            "items": [
              {}
            ]
          }
        },
        "displayName": "<unknown>",
        "personName": "<unknown>",
        "aliases": "<unknown>",
        "profileUrl": "<unknown>",
        "slug": "<unknown>",
        "category": "<unknown>",
        "location": "<unknown>",
        "headline": "<unknown>",
        "emails": "<unknown>",
        "emailDetails": [
          {
            "email": "jsmith@example.com",
            "type": "personal",
            "typeBasis": "consumer_domain",
            "verification": {
              "status": "deliverable",
              "verifiedAt": "2023-11-07T05:31:56Z",
              "catchAllDomain": true
            },
            "employer": {
              "association": "current",
              "companyName": "<string>",
              "companyDomain": "<string>"
            }
          }
        ],
        "employmentDomains": [
          {
            "isCurrent": true,
            "companyName": "<string>",
            "domain": "<string>"
          }
        ],
        "phoneNumbers": "<unknown>",
        "phoneDetails": [
          {
            "phoneNumber": "<string>",
            "type": "mobile",
            "isConnected": true,
            "firstReported": 123,
            "lastReported": 123
          }
        ],
        "addresses": "<unknown>"
      },
      "failure": {
        "code": "<string>",
        "message": "<string>",
        "retryable": true,
        "reason": "<string>",
        "suggested_inputs": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "links": {
    "status": "<string>"
  },
  "candidate_discovery_completed": true,
  "provider_results_final": true,
  "discovered_sources": [
    {
      "link": "<string>",
      "title": "<string>",
      "sourceImage": "<string>"
    }
  ],
  "candidate_discovery_failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "population": {
    "kind": "company",
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "profile_depth": "partial",
    "credits_quoted": 123,
    "status": "running"
  },
  "query_intent": {
    "organizations": [
      "<string>"
    ],
    "schools": [
      "<string>"
    ],
    "person_named": true
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "search_id": "<string>",
  "request_id": "<string>",
  "status": "running",
  "candidate_discovery": true,
  "profile_depth": "partial",
  "include_profile": true,
  "profile_upgrades_completed": true,
  "results": [
    {
      "profile_id": "<string>",
      "status": "generating",
      "generation_level": 2,
      "sources": [
        "search"
      ],
      "candidate_sources": [
        {
          "link": "<string>",
          "title": "<string>",
          "sourceImage": "<string>"
        }
      ],
      "preview": {},
      "profile": {
        "id": "<unknown>",
        "generationLevel": "<unknown>",
        "avatarUrl": "<unknown>",
        "verified": "<unknown>",
        "sections": {
          "socials": {
            "items": [
              {}
            ]
          },
          "bio": {
            "bio": "<string>"
          },
          "basic": {
            "items": [
              {}
            ]
          },
          "personalLife": {
            "items": [
              {}
            ]
          },
          "jobs": {
            "items": [
              {}
            ]
          },
          "education": {
            "items": [
              {}
            ]
          },
          "passions": {
            "items": [
              {}
            ]
          },
          "worldview": {
            "items": [
              {}
            ]
          },
          "accomplishments": {
            "items": [
              {}
            ]
          },
          "controversies": {
            "items": [
              {}
            ]
          },
          "bestQualities": {
            "items": [
              {}
            ]
          },
          "netWorth": {
            "items": [
              {}
            ]
          },
          "eventsTimeline": {
            "items": [
              {}
            ]
          },
          "portfolio": {
            "items": [
              {}
            ]
          },
          "families": {
            "items": [
              {}
            ]
          },
          "researchPapers": {
            "items": [
              {}
            ]
          },
          "githubRepos": {
            "items": [
              {}
            ]
          },
          "mediaCredits": {
            "items": [
              {}
            ]
          },
          "musicCredits": {
            "items": [
              {}
            ]
          },
          "books": {
            "items": [
              {}
            ]
          }
        },
        "displayName": "<unknown>",
        "personName": "<unknown>",
        "aliases": "<unknown>",
        "profileUrl": "<unknown>",
        "slug": "<unknown>",
        "category": "<unknown>",
        "location": "<unknown>",
        "headline": "<unknown>",
        "emails": "<unknown>",
        "emailDetails": [
          {
            "email": "jsmith@example.com",
            "type": "personal",
            "typeBasis": "consumer_domain",
            "verification": {
              "status": "deliverable",
              "verifiedAt": "2023-11-07T05:31:56Z",
              "catchAllDomain": true
            },
            "employer": {
              "association": "current",
              "companyName": "<string>",
              "companyDomain": "<string>"
            }
          }
        ],
        "employmentDomains": [
          {
            "isCurrent": true,
            "companyName": "<string>",
            "domain": "<string>"
          }
        ],
        "phoneNumbers": "<unknown>",
        "phoneDetails": [
          {
            "phoneNumber": "<string>",
            "type": "mobile",
            "isConnected": true,
            "firstReported": 123,
            "lastReported": 123
          }
        ],
        "addresses": "<unknown>"
      },
      "failure": {
        "code": "<string>",
        "message": "<string>",
        "retryable": true,
        "reason": "<string>",
        "suggested_inputs": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "links": {
    "status": "<string>"
  },
  "candidate_discovery_completed": true,
  "provider_results_final": true,
  "discovered_sources": [
    {
      "link": "<string>",
      "title": "<string>",
      "sourceImage": "<string>"
    }
  ],
  "candidate_discovery_failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "reason": "<string>",
    "suggested_inputs": [
      "<string>"
    ]
  },
  "population": {
    "kind": "company",
    "id": "<string>",
    "name": "<string>",
    "size": 123,
    "profile_depth": "partial",
    "credits_quoted": 123,
    "status": "running"
  },
  "query_intent": {
    "organizations": [
      "<string>"
    ],
    "schools": [
      "<string>"
    ],
    "person_named": true
  },
  "billing": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pricingVersion": "<string>",
    "reservedCredits": 1,
    "consumedCredits": 1,
    "releasedCredits": 1,
    "heldCredits": 1,
    "status": "open"
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

{
  "status": "failed",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requiredCredits": 1,
    "remainingCredits": 1
  }
}

Search

Enrich

Watchers

Webhooks

Keys

Request body

Response

Billing

Rate limits

Authorizations

Headers

Body

Response

​Request body

​Response

​Billing

​Rate limits

Authorizations

Headers

Body

Response

Request body

Response

Billing

Rate limits