{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/projects/:projectId/users","auth":"required","params":[{"name":"projectId","type":"string","default":"","desc":"The id of the project","required":true,"in":"path","ref":"","_id":"54ab036defb39016009e4d88"}],"results":{"codes":[{"status":204,"name":"","code":"// Success\n[\n    {\n        \"id\": \"6XX6X1X9-E130-2427-8641X1X2X3X4X8X\",\n        \"numericId\": 123,\n        \"defaultRoleTemplateId\": \"546119xxx4x0x15x291x054X\",\n        \"userName\": \"simon\",\n        \"accountId\": \"XXXX35823XXXX\",\n        \"firstName\": \"Simon\",\n        \"lastName\": \"Smith\",\n        \"company\": \"MediaSilo\",\n        \"dateCreated\": 1187236800000,\n        \"email\": \"simon:::at:::example.com\",\n        \"phone\": \"\",\n        \"mobile\": \"\",\n        \"address\": {\n            \"address1\": \"123 Front St.\",\n            \"address2\": \"\",\n            \"city\": \"Boston\",\n            \"province\": \"MA\",\n            \"postalCode\": \"02111\",\n            \"country\": \"US\"\n        },\n        \"status\": \"ACTIVE\",\n        \"sso\": false,\n        \"roles\": [],\n        \"tags\": [],\n        \"preferences\": []\n    }\n]","language":"json"}]},"method":"get","examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Get Users in Project","type":"endpoint","slug":"get-all-users-for-project","excerpt":"","body":"This returns all members of a given project.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nA user must be a PROJECT OWNER to read the users in a given project. Additionally, users with an account-level role of ADMINISTRATOR can read users from any project.","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54d52803ba860f0d003de534","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","releaseDate":"2014-10-07T18:47:13.086Z","__v":28,"createdAt":"2014-10-07T18:47:13.086Z","forked_from":"54343170fa5527080064f44c"},"category":{"sync":{"isSync":false,"url":""},"pages":["543493365b10711400c6c48e","54349a445b10711400c6c515","5434a0fe0ef9c008001652ed","54aafac199f6581600167c9a","54ab036defb39016009e4d85","54ab09c699f6581600167cc4","54ab6a8499f6581600167d42","54abf047ec3be11400c8af25","54abfcf2de18cc1400226dbc","54abfe45ec3be11400c8af64","54ac0037de18cc1400226dc7","54c6a0d5f2ab9319008e81aa","54d52803ba860f0d003de534"],"title":"Projects","slug":"projects","order":3,"from_sync":false,"reference":false,"_id":"543435bfedce040800409244","__v":13,"project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af","createdAt":"2014-10-07T18:49:35.512Z"},"githubsync":"","parentDoc":null,"__v":1,"user":"543532513513400800a144f4","createdAt":"2015-02-06T20:45:55.527Z","editedParams":true,"editedParams2":true,"project":"54343170fa5527080064f449"}

getGet Users in Project


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

projectId:
required
string
The id of the project

Result Format


Documentation

This returns all members of a given project. [block:api-header] { "type": "basic", "title": "Permissions" } [/block] A user must be a PROJECT OWNER to read the users in a given project. Additionally, users with an account-level role of ADMINISTRATOR can read users from any project.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}