# Namely API API

> Namely API API on Apizie: 54 endpoints (Company Info, Get all Folders, Create Folder, Get a Resource, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:namely/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:namely`
- Category: Open Data
- Status: byok
- Source: https://namely.com
- Page: https://zieapi.vercel.app/api/open-data/namely
- OpenAPI: https://zieapi.vercel.app/api/open-data/namely/openapi.json

Move your app forward with the Namely API Move your app forward with the Namely API

## Endpoints

### Company Info
`GET https://zieapi.vercel.app/v1/open-data:namely/company-info-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get all Folders
`GET https://zieapi.vercel.app/v1/open-data:namely/get-folders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Create Folder
`POST https://zieapi.vercel.app/v1/open-data:namely/post-folders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get a Resource
`GET https://zieapi.vercel.app/v1/open-data:namely/company-resources-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | The resource's id. |

### Get Resources in a Folder
`GET https://zieapi.vercel.app/v1/open-data:namely/company-resources-get-folder-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | Use the folder id to pull the resources you want to see. |

### Delete Resource
`POST https://zieapi.vercel.app/v1/open-data:namely/company-resources-delete-resource-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | Use the folder id to pull the resources you want to see. |

### Get Resources not in a Folder
`GET https://zieapi.vercel.app/v1/open-data:namely/get-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Update Folder
`POST https://zieapi.vercel.app/v1/open-data:namely/company-resources-update-folder-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the folder you want to update |
| body | object | no | JSON request body |

### Delete Folder
`POST https://zieapi.vercel.app/v1/open-data:namely/company-resources-delete-folder-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the folder you want to update |

### Get all Groups
`GET https://zieapi.vercel.app/v1/open-data:namely/get-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Group
`GET https://zieapi.vercel.app/v1/open-data:namely/groups-teams-get-group-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the group you want to view |

### Get all Group Types
`GET https://zieapi.vercel.app/v1/open-data:namely/groups-teams-get-all-group-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Group Type
`GET https://zieapi.vercel.app/v1/open-data:namely/groups-teams-get-group-type-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the group type you want to view |

### Get Groups from Group Type
`GET https://zieapi.vercel.app/v1/open-data:namely/groups-teams-get-group-type-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes |  |

### Get all Teams
`GET https://zieapi.vercel.app/v1/open-data:namely/get-teams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Team
`GET https://zieapi.vercel.app/v1/open-data:namely/groups-teams-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the team you want to view |

### Get all Events
`GET https://zieapi.vercel.app/v1/open-data:namely/get-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| limit | integer | no | Limit of records to be retrieved |
| after | string | no | id of the first record BEFORE the events you want to retrieve |
| filter[type] | string | no | The type of event you want to retrieve; examples include `birthday`, `announcement`, `recent_arrival` or `anniversary` |
| profile_id | string | no | id of the profile that you wish to pull all associated events from |
| order | string | no | This parameter allows you to change how results are ordered. Valid values are `asc` and `desc` - It defaults to `desc` |

### Create an Announcement
`POST https://zieapi.vercel.app/v1/open-data:namely/post-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get an Event
`GET https://zieapi.vercel.app/v1/open-data:namely/home-feed-get-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of event. |

### Delete an Announcement
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-delete-announcement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of event. |

### Get an Event's Comments
`GET https://zieapi.vercel.app/v1/open-data:namely/home-feed-get-event-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| event-id | string | yes | id of the event whose comments you want to view |

### Get an Event's Likes
`GET https://zieapi.vercel.app/v1/open-data:namely/home-feed-get-event-likes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| event-id | string | yes | id of the event whose likes you want to view |

### Get an Event's Comment's Likes
`GET https://zieapi.vercel.app/v1/open-data:namely/home-feed-get-event-comment-likes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| comment-id | string | yes | id of the comment whose likes you want to view |

### Create an Event's Comment
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-create-event-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of event. |
| body | object | no | JSON request body |

### Create an Event's Like
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-create-event-like` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the event you want to like |

### Create an Event's Comment's Like
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-like-event-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| comment-id | string | yes | id of the comment you want to like |

### Delete an Event's Comment's Like
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-delete-event-comment-like` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| comment-id | string | yes | id of the comment you want to like |

### Delete an Event's Comment
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-remove-event-comment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| event-id | string | yes | id of the event to which the comment belongs |
| comment-id | string | yes | id of the comment you want to delete from the event |

### Delete an Event's Like
`POST https://zieapi.vercel.app/v1/open-data:namely/home-feed-remove-event-like` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| event-id | string | yes | id of the event from which you want to delete the like |
| body | object | no | JSON request body |

### Get all Job Tiers
`GET https://zieapi.vercel.app/v1/open-data:namely/jobs-info-get-all-job-tiers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Create a Job Tier
`POST https://zieapi.vercel.app/v1/open-data:namely/jobs-info-create-job-tier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get a Job Tier
`GET https://zieapi.vercel.app/v1/open-data:namely/jobs-info-get-job-tier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the job tier you want to view |

### Update a Job Tier
`POST https://zieapi.vercel.app/v1/open-data:namely/jobs-info-update-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the job tier you want to view |
| body | object | no | JSON request body |

### Get all Job Titles
`GET https://zieapi.vercel.app/v1/open-data:namely/jobs-info-get-all-job-titles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Create a Job Title
`POST https://zieapi.vercel.app/v1/open-data:namely/jobs-info-create-job-title` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get a Job Title
`GET https://zieapi.vercel.app/v1/open-data:namely/jobs-info-get-job-title-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the job title you want to view |

### Update a Job Title
`POST https://zieapi.vercel.app/v1/open-data:namely/jobs-info-update-job-title` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the job title you want to view |
| body | object | no | JSON request body |

### Get all Countries
`GET https://zieapi.vercel.app/v1/open-data:namely/get-countries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Country
`GET https://zieapi.vercel.app/v1/open-data:namely/namely-system-info-get-country-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the country (an abbreviation of the country's name) you want to view |

### Get all Notifications
`GET https://zieapi.vercel.app/v1/open-data:namely/get-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Profile's Notifications
`GET https://zieapi.vercel.app/v1/open-data:namely/notifications-get-profile-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile whose notifications you want to view |
| page | integer | no | the page of information you'd like to receive. |
| per_page | integer | no | the number of employees to retrieve when using pagination; default is 30 and the limit is 50. |

### Get all Profile Fields
`GET https://zieapi.vercel.app/v1/open-data:namely/profile-fields-get-all-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Create a Profile Field
`POST https://zieapi.vercel.app/v1/open-data:namely/profile-fields-create-profile-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get a Profile Field
`GET https://zieapi.vercel.app/v1/open-data:namely/profile-fields-get-field-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile field you want to view |

### Update a Profile Field
`POST https://zieapi.vercel.app/v1/open-data:namely/profile-fields-update-field-in-section` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile field you want to view |
| body | object | no | JSON request body |

### Get all Profile Field Sections
`GET https://zieapi.vercel.app/v1/open-data:namely/profile-fields-get-all-field-sections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Profile Field Section
`GET https://zieapi.vercel.app/v1/open-data:namely/profile-fields-get-field-section` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile field section you want to view |

### Update a Profile Field Section
`POST https://zieapi.vercel.app/v1/open-data:namely/profile-fields-update-field-in-section-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile field section you want to view |
| body | object | no | JSON request body |

### Get all Profiles
`GET https://zieapi.vercel.app/v1/open-data:namely/get-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| page | integer | no | the page of information you'd like to receive. |
| per_page | integer | no | the number of employees to retrieve when using pagination; default is 30 and the limit is 50. |
| profile_format | string | no | format of the profile object; only short is supported - returns a truncated version of the profile object |
| sort | string | no | sort order of profiles; valid values - first_name , last_name , created_at , updated_at ; prepend with a - (minus) sign to reverse the order |
| filter[first_name] | string | no | returns only profiles with the defined first name |
| filter[last_name] | string | no | returns only profiles with the defined last name |
| filter[email] | string | no | returns only profiles with the defined (company) email |
| filter[personal_email] | string | no | returns only profiles with the defined personal email |
| filter[job_title] | string | no | returns only profiles with the defined job title; must be the job_title's title |
| filter[reports_to] | string | no | id of the profile for whose direct reports you to view; returns only those profiles |
| filter[user_status] | string | no | returns only profiles with the defined user_status ; active , pending , and inactive are supported |

### Create a Profile
`POST https://zieapi.vercel.app/v1/open-data:namely/post-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| body | object | no | JSON request body |

### Get a Profile
`GET https://zieapi.vercel.app/v1/open-data:namely/profiles-get-profile-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile you want to view |

### Update a Profile
`POST https://zieapi.vercel.app/v1/open-data:namely/profiles-update-profile-with-new-job-title` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the profile you want to view |
| body | object | no | JSON request body |

### Get Current User's Profile
`GET https://zieapi.vercel.app/v1/open-data:namely/profiles-get-current-user-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |

### Get a Report
`GET https://zieapi.vercel.app/v1/open-data:namely/reports-get-report-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company | string | yes | Part of the server address: https://{company}.namely.com/api/v1 |
| id | string | yes | id of the report from Namely; can be found at the end of the URL of the report on the web |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:namely/company-info-get-info" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Namely API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:namely/company-info-get-info with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Namely API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Namely API itself also needs your own key from {company}.namely.com.

### Can AI agents use the Namely API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:namely.

### What is the status of the Namely API API?
Needs your own provider key (bring your own key)