> ## Documentation Index
> Fetch the complete documentation index at: https://lava.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Namely

> Namely REST API access for reading employee profiles, job titles, and teams for a connected Namely company.

Namely REST API access for reading employee profiles, job titles, and teams for a connected Namely company. Use when an agent needs employee directory or profile data from Namely. Routes through Pipedream Connect; each company lives on its own Namely subdomain, which Pipedream resolves, and Lava holds no Namely token.

5 example endpoints available through Lava's AI Gateway. See the [Namely API docs](https://developers.namely.com/) for full documentation.

<Warning>This provider requires your own credentials — connect your API key or OAuth account before use.</Warning>

<Info>This is a **catch-all provider** — any valid URL under `https://company.namely.com` is supported. Namely REST API v1. Each company lives at https\://\{company}.namely.com; the literal host company.namely.com always works because the gateway routes by path and Pipedream resolves the connected subdomain. Reads under /api/v1: /api/v1/profiles (employees), /api/v1/profiles/\{id} (one), /api/v1/profiles/me (the current user, an identity probe), /api/v1/job\_titles, /api/v1/groups. Pagination is page and per\_page (default 30); responses carry meta.total\_count. Auth is brokered by Pipedream, do not send an Authorization header. This provider is read-only: only GET requests are supported. The endpoints below are curated examples.</Info>

## Endpoints

### List employee profiles (active and inactive). Paginate with page and per\_page.

**GET** `https://company.namely.com/api/v1/profiles?page=1&per_page=30` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://company.namely.com/api/v1/profiles?page=1&per_page=30', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fcompany.namely.com%2Fapi%2Fv1%2Fprofiles%3Fpage%3D1%26per_page%3D30" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get a single employee profile by id, including custom fields.

**GET** `https://company.namely.com/api/v1/profiles/{id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://company.namely.com/api/v1/profiles/{id}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fcompany.namely.com%2Fapi%2Fv1%2Fprofiles%2F%7Bid%7D" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get the authenticated user's own profile. Use as a cheap identity probe after connect.

**GET** `https://company.namely.com/api/v1/profiles/me` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://company.namely.com/api/v1/profiles/me', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fcompany.namely.com%2Fapi%2Fv1%2Fprofiles%2Fme" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List all job titles.

**GET** `https://company.namely.com/api/v1/job_titles` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://company.namely.com/api/v1/job_titles', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fcompany.namely.com%2Fapi%2Fv1%2Fjob_titles" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List groups (and use /api/v1/teams for teams).

**GET** `https://company.namely.com/api/v1/groups` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://company.namely.com/api/v1/groups', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fcompany.namely.com%2Fapi%2Fv1%2Fgroups" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="All Providers" icon="grid" href="/gateway/supported-providers">
    Browse all supported AI providers
  </Card>

  <Card title="Forward Proxy" icon="route" href="/gateway/forward-proxy">
    Learn how to construct proxy URLs and authenticate requests
  </Card>
</CardGroup>