{"id":19000474,"url":"https://github.com/typesense/postman","last_synced_at":"2025-04-09T21:21:34.809Z","repository":{"id":43948877,"uuid":"403257016","full_name":"typesense/postman","owner":"typesense","description":"Postman collection for Typesense","archived":false,"fork":false,"pushed_at":"2025-03-06T22:21:24.000Z","size":1141,"stargazers_count":30,"open_issues_count":0,"forks_count":50,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-02T20:11:09.848Z","etag":null,"topics":["postman","typesense"],"latest_commit_sha":null,"homepage":"https://typesense.org/docs/latest/api/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typesense.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-05T08:39:37.000Z","updated_at":"2025-04-01T17:48:00.000Z","dependencies_parsed_at":"2025-03-06T23:22:06.202Z","dependency_job_id":"7c3d86b9-e133-4077-8159-443228b0406f","html_url":"https://github.com/typesense/postman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fpostman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fpostman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fpostman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Fpostman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesense","download_url":"https://codeload.github.com/typesense/postman/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248112456,"owners_count":21049660,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["postman","typesense"],"created_at":"2024-11-08T18:07:24.828Z","updated_at":"2025-04-09T21:21:34.790Z","avatar_url":"https://github.com/typesense.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Postman collection for Typesense\n\nCalling Typesense API via `curl` commands on your terminal can be a bit cumbersome.\n\nThankfully, we've put together a \u003ca href=\"https://www.postman.com/typesense/workspace/typesense-api/overview\"\u003ePostman collection\u003c/a\u003e that you can use and share with your team. We'll also be happy to accept any changes or improvements -- send us a PR!\n\nThere are two methods you can use our postman collection. One is from the postman public API directory and other is just download the json from this Github repository and import it to your postman. We have shared the steps below for both the methods.\n\n# Method - 1 - Importing from postman public API directory\nNavigate to this \u003ca href=\"typesense.postman_collection.json\" download=\"https://www.postman.com/typesense/workspace/typesense-api/overview\"\u003ePostman collection\u003c/a\u003e, login into your postman click on typesense on to the left and select fork. Forking creates a copy of the collection in your account. \n\n![](/screenshots/Fork_1.png)\n\nGive it a name and the workspace to which you want to import it.\n\n![Collection](/screenshots/fork_2.png)\n\n## Import the environment\n\nWe have provided the [Postman Environment](/typesense.postman_environment.json), you need to import that as well.\n\n![Environment Import](/screenshots/env_import.png)\n---\n**NOTE**\n\nTo get a better understanding of what postman environments are take a look at [this.](https://learning.postman.com/docs/sending-requests/managing-environments/)\n\n# Method - 2 - Importing from Github Repository\n## Usage Instructions\n\nIn case you're not familiar with Postman, here's a quick walk-through on importing and using this collection.\n\n### Step 1️⃣: Import the collection\n\nDownloaded the [Postman collection](typesense.postman_collection.json), and import it into Postman.\n\n![Collection import](/screenshots/Import.png)\n\nYou should now be able to see the collection on the left sidebar.\n\n![Collection](/screenshots/collection.png)\n\n### Step 2️⃣: Import the environment\n\nWe have also provided a [Postman Environment](/typesense.postman_environment.json) -- you need to import that as well.\n\n![Environment Import](/screenshots/env_import.png)\n\n\u003e To get a better understanding of what Postman environments are, please [look here](https://learning.postman.com/docs/sending-requests/managing-environments/).\n\n### Step 3️⃣: Edit the environment variables\n\n![Edit](/screenshots/edit_collection.png)\n\nUpdate the `TYPESENSE_API_KEY` variable match the API key that you use.\n\n![Edit API Key](/screenshots/set_api_url.png)\n\nUpdate the `url` to point to your local or remote Typesense server:\n\n![Edit url](/screenshots/set_api_url.png)\n\n### ✨ And that's it!\n\nYou can now use the Postman collection to hit the Typesense APIs.\n\n![Create collection](/screenshots/create_collection.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fpostman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesense%2Fpostman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Fpostman/lists"}