# Getting started

1. ## Get an API key

   Create a key in your dashboard. It is shown once, so copy it somewhere safe.

   [Open dashboard](https://envoapi.com/dashboard/keys)
   [How keys work](https://docs.envoapi.com/guides/authentication.md)

2. ## Send one request

   Put the key in the `Authorization` header. This call looks up one profile by username.

   ```bash method="GET" path="/v1/profiles/details/by-username"
   curl "https://api.envoapi.com/v1/profiles/details/by-username?username=<USERNAME>" \
     -H "Authorization: Bearer $ENVO_API_KEY" \
     -H "Accept: application/json"
   ```

   [Look up a company instead](https://docs.envoapi.com/api/operations/getcompanydetailsbyslug.md)

3. ## Read the response

   The profile is in `data`. The credits this call used are in `meta`.

   ```json mime="application/json" status="200 OK"
   {
     "data": { "publicId": "profile_…", "fullName": "…", "headline": "…", … },
     "meta": { "creditCost": <CREDITS_USED> }
   }
   ```

   `X-Credits-Remaining`

   credits left on your account

   `X-Request-Id`

   keep this if you contact support

## Where next

* [Profile lookup reference](https://docs.envoapi.com/api/operations/getprofiledetailsbyusername.md)

* [Errors guide](https://docs.envoapi.com/guides/errors.md)

* [Company lookup reference](https://docs.envoapi.com/api/operations/getcompanydetailsbyslug.md)

* [Rate limits guide](https://docs.envoapi.com/guides/rate-limits.md)

* [Search people reference](https://docs.envoapi.com/api/operations/searchpeoplebykeyword.md)

* [All endpoints reference](https://docs.envoapi.com/api/index.md)

[Documentation index](https://docs.envoapi.com/llms.txt) · [All endpoints](https://docs.envoapi.com/api/index.md)