Start
Start here
Core workflows
Workspace management
Developer resources
Agent resources
Developer resource
Use the Mjhr API
Use the public API when another backend, reporting job, or agent needs to read Mjhr workspace data. Start by confirming the workspace, then let the user or workflow choose a saved search before reading results.
Typical read flow
- 1. Confirm the workspace with /v1/workspace.
- 2. List saved searches with /v1/searches.
- 3. Read companies from /v1/searches/{searchId}/results.
- 4. Use folders when the workflow needs organization context.
Base URL
https://api.mjhr.ai/v1Endpoints
| Method | Path | Operation | Summary |
|---|---|---|---|
| GET | /v1/workspace | get_workspace | Get workspace metadata |
| GET | /v1/countries | list_countries | List Search country references |
| GET | /v1/cities | list_cities | List Search city references |
| GET | /v1/cities/{cityId} | get_city | Get a Search city reference |
| GET | /v1/cities/{cityId}/districts | list_city_districts | List city district references |
| GET | /v1/categories | list_categories | List Search category references |
| GET | /v1/searches | list_searches | List saved searches |
| POST | /v1/searches | create_search | Submit a new saved search |
| GET | /v1/searches/{searchId} | get_search | Get a saved search |
| GET | /v1/searches/{searchId}/results | list_search_results | List saved search results |
| GET | /v1/results/{searchId} | list_result_companies | List result companies |
| GET | /v1/results/{searchId}/branches | list_result_branches | List result branches |
| GET | /v1/results/{searchId}/{companyId} | list_company_result_branches | List one result company’s branches |
| POST | /v1/results/{searchId}/folder | move_result_to_folder | Move a result set to a folder |
| POST | /v1/results/{searchId}/archive | archive_result_set | Archive a result set |
| GET | /v1/folders | list_folders | List search-history folders |
| POST | /v1/folders | create_folder | Create a search-history folder |
| POST | /v1/folders/{folderId}/archive | archive_folder | Archive a search-history folder |
| GET | /v1/lists | list_branch_lists | List active Branch Lists |
| POST | /v1/lists | create_branch_list | Create a Branch List |
| GET | /v1/lists/{listId} | get_branch_list | Get Branch List metadata |
| POST | /v1/lists/{listId}/rename | rename_branch_list | Rename a Branch List |
| POST | /v1/lists/{listId}/archive | archive_branch_list | Archive a Branch List |
| GET | /v1/lists/{listId}/members | list_branch_list_members | List Branch List members |
| POST | /v1/lists/{listId}/members | add_branch_list_members | Add Branches to a List |
| POST | /v1/lists/{listId}/members/remove | remove_branch_list_members | Remove Branches from a List |
| POST | /v1/lists/{listId}/order | reorder_branch_list_members | Replace Branch List order |
Authentication
Send a scoped API key with each request. Keep API keys server-side and issue the smallest scope set needed by the integration.
Authorization header
Authorization: Bearer <API_KEY>