{"id":18284185,"url":"https://github.com/blimpllc/blimp-php","last_synced_at":"2025-04-05T07:31:18.125Z","repository":{"id":6391762,"uuid":"7629609","full_name":"blimpllc/blimp-php","owner":"blimpllc","description":"Blimp API PHP Library","archived":false,"fork":false,"pushed_at":"2013-02-02T02:25:12.000Z","size":167,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-21T00:26:04.644Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://dev.getblimp.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-01-15T17:29:30.000Z","updated_at":"2021-11-01T19:05:44.000Z","dependencies_parsed_at":"2022-07-29T01:49:10.893Z","dependency_job_id":null,"html_url":"https://github.com/blimpllc/blimp-php","commit_stats":null,"previous_names":["blimpio/blimp-php","getblimp/blimp-php","blimpllc/blimp-php"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimpllc%2Fblimp-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blimpllc","download_url":"https://codeload.github.com/blimpllc/blimp-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305414,"owners_count":20917197,"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-11-05T13:12:34.071Z","updated_at":"2025-04-05T07:31:13.114Z","avatar_url":"https://github.com/blimpllc.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# blimp-php\n\n[![Build Status](https://travis-ci.org/GetBlimp/blimp-php.png?branch=master)](https://travis-ci.org/GetBlimp/blimp-php)\n\nThis library allows you to interact with the Blimp API using PHP. 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 PHP library).\n\n## License\nLicensed under the MIT License.\n\n## Install\n\nUsing Github:\n\n```\ngit clone git@github.com:getblimp/blimp-php\n````\n\nUsing [Composer](http://getcomposer.org/):\n\n```\n{\n\t\"require\": {\n\t\t\"blimp/client\": \"dev-master\"\n\t}\n}\n```\n\nThen run:\n\n```\ncomposer install\n```\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```php\n\n# load the client using Composer's autoloader\nrequire_once 'vendor/autoload.php';\n\n$client = new Blimp\\Client($username, $api_key, $app_id, $app_secret);\n\n# or load the client without an autoloader\nrequire_once 'src/BlimpClient.php';\n\n$client = new BlimpClient($username, $api_key, $app_id, $app_secret);\n\n# get all companies that I'm part of\n$companies = $client-\u003eget('company');\n\n# get one company by id\n$companies = $client-\u003eget('company', 1);\n\n# get all projects for one company\n$projects = $client-\u003eget('project', null, array('company' =\u003e 1));\n\n# get count of total projects\n$total_projects = $projects-\u003emeta-\u003etotal_count;\n\n# Loop through all projects and print their name\nforeach($projects-\u003eobjects as $project) {\n    echo $project-\u003ename;\n}\n\n# Get all goals for a project\n$goals = $client.get('goal', null, array('project' =\u003e 1));\n\n# Get all tasks for a goal\n$tasks = $client.get('task', null, array('goal' =\u003e 1));\n\n# Get all comments for a task\n$comments = $client.get('comment', null, array('content_type' =\u003e 'todo', 'object_pk': 1));\n\n# Get schema for all available endpoints\nprint_r($client-\u003eschema('company'));\nprint_r($client-\u003eschema('project'));\nprint_r($client-\u003eschema('goal'));\nprint_r($client-\u003eschema('task'));\nprint_r($client-\u003eschema('comment'));\nprint_r($client-\u003eschema('file'));\nprint_r($client-\u003eschema('user'));\n\n# All available methods per endpoint\n# $client.get($resource_name);\n# $client.get($resource_name, $id);\n# $client.create($resource_name, $data);\n# $client.update($resource_name, $id, $data);\n# $client.delete($resource_name, $id);\n# $client.schema($resource_name);\n```\n\n### Example response of all companies I'm part of\n```JSON\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-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblimpllc%2Fblimp-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimpllc%2Fblimp-php/lists"}