View as Markdown

Get Company

GET/v2/companies/{id}

Read one company by its GetProspect id, with your workspace's saved block (lists, saved_at, name edit). An unknown company answers 404 NOT_FOUND. Free: spends no credits; 1 unit of the enrich rate limit, none for a company your workspace saved.

Path parameters

  • idstringrequired

    The GetProspect company id (24 hexadecimal characters), as id on every company answer.

    Example: "696fb12757da999990585cfd"

Responses

  • 200 The company, with saved when your workspace saved it.
  • 400 Invalid request (VALIDATION_ERROR; payload.code says which kind of mistake).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 404 No such company (NOT_FOUND): unknown, erased, or blocked by your workspace, which are not told apart.
  • 429 Over the enrich rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.