{"id":15043011,"url":"https://github.com/blimpllc/blimp-node","last_synced_at":"2025-04-14T20:34:21.575Z","repository":{"id":7204391,"uuid":"8509397","full_name":"blimpllc/blimp-node","owner":"blimpllc","description":"Node Library for the Blimp API.","archived":false,"fork":false,"pushed_at":"2013-03-01T20:14:47.000Z","size":108,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T08:51:15.754Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/blimpllc.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}},"created_at":"2013-03-01T20:12:17.000Z","updated_at":"2021-11-01T19:05:15.000Z","dependencies_parsed_at":"2022-08-24T20:02:18.030Z","dependency_job_id":null,"html_url":"https://github.com/blimpllc/blimp-node","commit_stats":null,"previous_names":["blimpio/blimp-node","getblimp/blimp-node","blimpllc/blimp-node"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blimpllc","download_url":"https://codeload.github.com/blimpllc/blimp-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248956656,"owners_count":21189385,"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":[],"created_at":"2024-09-24T20:48:27.380Z","updated_at":"2025-04-14T20:34:21.556Z","avatar_url":"https://github.com/blimpllc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# blimp-node #\n\nThis library allows you to interact with the Blimp API using Node. You can find more information\nabout Blimp's Public API documentation at [http://dev.getblimp.com/](http://dev.getblimp.com/).\nIf you have any problems or requests please contact [support](mailto:support@getblimp.com?subject=Blimp API Python library).\n\n## License ##\nLicensed under the MIT License.\n\n## Install ##\n\n```\nnpm install blimp\n```\n## Pre-Usage ##\n\nBefore we begin using the library you need to signup to [Blimp](http://app.getblimp.com/) and generate a new API Key if you don't have one in your [settings](https://app.getblimp.com/user/settings/api/) as well as an Application ID and Secret in your [applications](https://app.getblimp.com/user/settings/api/developers/).\n\n## Usage ##\n\n```\nvar Blimp = require('blimp');\n\nvar blimp = new Blimp({\n    username: 'username',\n    apiKey: 'apikey',\n    appId: 'appid',\n    secret: 'secret'\n});\n\n// get all companies that I'm part of\nblimp.get('company', function(results) {\n    console.log(results);\n});\n\n// get one company by id\nblimp.get('company', 1, function(results) {\n    console.log(results);\n});\n\n// get all projects for one company\nblimp.get('company', {company: 1}, function(results) {\n    console.log(results);\n});\n\n// get count of total projects\nblimp.get('project', function(results) {\n    console.log(JSON.parse(results).meta.total_count);\n});\n\n// Loop through all projects and print their name\nblimp.get('project', function(results) {\n    JSON.parse(results).objects.forEach(function(project) {\n        console.log(project.name);\n    });\n});\n\n// Get all goals for a project\nblimp.get('goal', {project: 1}, function(results) {\n    console.log(results);\n});\n\n// Get all tasks for a goal\nblimp.get('task', {goal: 1}, function(results) {\n    console.log(results);\n});\n\n// Get all comments for a task\nblimp.get('comment', {content_type: 'todo', object_pk: 1}, function(results) {\n    console.log(results);\n});\n\n// Get schema for company endpoint\nblimp.schema('company', function(schema) {\n    console.log(schema);\n});\n\n// All available methods per endpoint\n// blimp.get(resource, [id], [params], callback)\n// blimp.post(resource, data, [params], callback)\n// blimp.put(resource, id, [params], data, callback)\n// blimp.del(resource, id, callback)\n// blimp.schema(resource, callback)\n```\n### Example response of all companies I'm part of ###\n```\n{\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": null,\n        \"offset\": 0,\n        \"previous\": null,\n        \"total_count\": 1\n    },\n    \"objects\": [\n        {\n            \"company_users\": [\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.817265\",\n                    \"id\": 38,\n                    \"is_active\": true,\n                    \"role\": \"admin\",\n                    \"user\": \"/api/v2/user/3/\"\n                },\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.705959\",\n                    \"id\": 37,\n                    \"is_active\": true,\n                    \"role\": \"admin\",\n                    \"user\": \"/api/v2/user/2/\"\n                },\n                {\n                    \"accepted_invitation\": true,\n                    \"date_created\": \"2012-11-01T00:00:00\",\n                    \"date_modified\": \"2012-11-27T02:22:09.380851\",\n                    \"id\": 39,\n                    \"is_active\": true,\n                    \"role\": \"owner\",\n                    \"user\": \"/api/v2/user/1/\"\n                }\n            ],\n            \"date_created\": \"2012-11-01T00:00:00\",\n            \"date_modified\": \"2012-12-21T21:57:09.965247\",\n            \"id\": 1,\n            \"image_url\": \"\",\n            \"name\": \"Blimp\",\n            \"resource_uri\": \"/api/v2/company/1/\",\n            \"slug\": \"blimp\",\n            \"used_projects\": 0,\n            \"used_storage\": \"4929882\"\n        }\n    ]\n}\n```\n\n## Improvements\nWhat else would you like this library to do? Let me know. Feel free to send pull requests for any improvements you make.\n\n### Todo\n* Tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fblimp-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblimpllc%2Fblimp-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fblimp-node/lists"}