{"__v":1,"_id":"581b78dc24d8c30f00abf13d","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-03T17:50:20.141Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/teams","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"results\": [{\n    \"_id\": \"5sptmGaYoc8D2Cv4Z\",\n    \"createdAt\": \"2016-11-02T21:13:41.296Z\",\n    \"modifiedAt\": \"2016-11-02T21:13:41.296Z\",\n    \"name\": \"my team\",\n    \"users\": [{\n      \"accepted\": true,\n      \"dateAccepted\": \"2016-11-02T21:13:41.296Z\",\n      \"dateInvited\": \"2016-11-02T21:13:41.296Z\",\n      \"role\": \"admin\",\n      \"userId\": \"TNonXrfCfvxEgoAvN\"\n    }, {\n      \"accepted\": true,\n      \"dateAccepted\": \"2016-11-02T21:27:02.485Z\",\n      \"dateInvited\": \"2016-11-02T21:13:41.330Z\",\n      \"role\": \"member\",\n      \"userId\": \"kZYPwDDiGPTfQDj5n\"\n    }, {\n      \"dateInvited\": \"2016-11-02T21:13:41.330Z\",\n      \"email\": \"hello:::at:::mixmax.com\",\n      \"role\": \"member\"\n    }]\n  }]\n}\n","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5837498111953b0f00eb661f","ref":"","in":"query","required":false,"desc":"True to include members that were removed from teams","default":"false","type":"boolean","name":"includeRemovedMembers"}],"url":"/v1/teams"},"isReference":true,"order":61,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"*String*\",\n    \"0-2\": \"Unique ID\",\n    \"3-0\": \"name\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"User-defined name of team\",\n    \"4-0\": \"users\",\n    \"4-1\": \"*Array*\",\n    \"4-2\": \"Team members. Use `expand=users` to see user names. Objects described below.\",\n    \"1-0\": \"createdAt\",\n    \"1-1\": \"*Date*\",\n    \"1-2\": \"When the team was created\",\n    \"2-0\": \"modifiedAt\",\n    \"2-1\": \"*Date*\",\n    \"2-2\": \"When the team name was last modified\",\n    \"5-0\": \"users.userId\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"User id. **Supports expansion**: pass `expand=user.userId` on the URL to expand the object to include `_id`, `email`, and `name` properties.\",\n    \"8-0\": \"users.email\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"If the member hasn't accepted the invite, this is their email address\",\n    \"9-0\": \"users.role\",\n    \"9-1\": \"*String*\",\n    \"9-2\": \"The role on the team. Either *admin* or *member*.\",\n    \"10-0\": \"users.created\",\n    \"10-1\": \"*Date*\",\n    \"10-2\": \"When the user was first invited\",\n    \"11-0\": \"users.dateInvited\",\n    \"11-1\": \"*Date*\",\n    \"11-2\": \"The last time the invite was sent\",\n    \"12-0\": \"users.dateAccepted\",\n    \"12-1\": \"*Date*\",\n    \"12-2\": \"The last time the invitation was altered (accepted/rejected/left/removed)\",\n    \"6-0\": \"users.accepted\",\n    \"6-1\": \"*Boolean*\",\n    \"6-2\": \"Whether the invite has been accepted or rejected (this field doesn't exist if pending)\",\n    \"7-0\": \"users.removed\",\n    \"7-2\": \"Whether the user was removed or left voluntarily\",\n    \"7-1\": \"*Boolean*\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","excerpt":"Returns teams and team membership for teams that you are on","slug":"teams","type":"get","title":"/teams"}

get/teams

Returns teams and team membership for teams that you are on

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

includeRemovedMembers:
booleanfalse
True to include members that were removed from teams

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "Unique ID", "3-0": "name", "3-1": "*String*", "3-2": "User-defined name of team", "4-0": "users", "4-1": "*Array*", "4-2": "Team members. Use `expand=users` to see user names. Objects described below.", "1-0": "createdAt", "1-1": "*Date*", "1-2": "When the team was created", "2-0": "modifiedAt", "2-1": "*Date*", "2-2": "When the team name was last modified", "5-0": "users.userId", "5-1": "*String*", "5-2": "User id. **Supports expansion**: pass `expand=user.userId` on the URL to expand the object to include `_id`, `email`, and `name` properties.", "8-0": "users.email", "8-1": "*String*", "8-2": "If the member hasn't accepted the invite, this is their email address", "9-0": "users.role", "9-1": "*String*", "9-2": "The role on the team. Either *admin* or *member*.", "10-0": "users.created", "10-1": "*Date*", "10-2": "When the user was first invited", "11-0": "users.dateInvited", "11-1": "*Date*", "11-2": "The last time the invite was sent", "12-0": "users.dateAccepted", "12-1": "*Date*", "12-2": "The last time the invitation was altered (accepted/rejected/left/removed)", "6-0": "users.accepted", "6-1": "*Boolean*", "6-2": "Whether the invite has been accepted or rejected (this field doesn't exist if pending)", "7-0": "users.removed", "7-2": "Whether the user was removed or left voluntarily", "7-1": "*Boolean*" }, "cols": 3, "rows": 13 } [/block]

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 }}