{"_id":"58267b9dd3f6413700617eab","category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"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,"version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"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","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":5,"user":"5588b847f6c18d0d005bba01","project":"5588b8a2f6c18d0d005bba03","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-12T02:17:01.750Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n   \"_id\":\"D7M6ZiZrv3v9YxQ8C\",\n   \"createdAt\":\"2016-11-12T00:41:38.879Z\",\n   \"modifiedAt\":\"2016-11-12T00:41:38.879Z\",\n   \"name\":\"team\",\n   \"members\":[\n      {\n         \"accepted\":true,\n         \"acceptedAt\":\"2016-11-12T00:41:38.879Z\",\n         \"invitedAt\":\"2016-11-12T00:41:38.879Z\",\n         \"role\":\"admin\",\n         \"memberId\": \"58e56361a32875961468970f\",\n         \"userId\":{\n            \"_id\":\"BGb7nYTSKfPtnPsgj\",\n            \"email\":\"hello:::at:::mixmax.com\",\n            \"name\":\"Mixmax Hello\"\n         }\n      },\n      {\n         \"accepted\":true,\n         \"dateAccepted\":\"2016-11-12T00:41:45.988Z\",\n         \"dateInvited\":\"2016-11-12T00:41:38.901Z\",\n         \"role\":\"member\",\n         \"memberId\": \"GXbhSiPuaJutLQ6wo\",\n         \"userId\": {\n            \"_id\":\"Emm7G4xCgCpha93qa\",\n            \"email\":\"jane@mixmax.com\",\n            \"name\":\"Jane Bar\"\n         }\n      }\n   ]\n}","language":"json","status":200},{"name":"","code":"","language":"json","status":404}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/teams/5sptmGaYoc8D2Cv4Z??expand=members,members.userId"}]},"auth":"required","params":[{"_id":"58267b9dd3f6413700617eac","ref":"","in":"path","required":true,"desc":"The _id of the team","default":"","type":"string","name":"id"},{"_id":"58a756db4a28a40f005c7d74","ref":"","in":"query","required":false,"desc":"Pass `expand=members` in the querystring return the members of the team. Pass `expand=members,members.userId` on the querystring to expand on members and see their names and emails.","default":"","type":"string","name":"expand"}],"url":"/v1/teams/:id"},"isReference":true,"order":127,"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\": \"members\",\n    \"4-1\": \"*Array*\",\n    \"4-2\": \"Team members. Use `expand=members` to see user names. Objects properties described [here](http://developer.mixmax.com/docs/get-teams-id-members-coming-soon)\",\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  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\nFor response format, see [/teams](http://developer.mixmax.com/docs/teams).","excerpt":"Fetch a team by id","slug":"teams-id","type":"endpoint","title":"/teams/:id"}

get/teams/:id

Fetch a team by id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The _id of the team

Query Params

expand:
string
Pass `expand=members` in the querystring return the members of the team. Pass `expand=members,members.userId` on the querystring to expand on members and see their names and emails.

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": "members", "4-1": "*Array*", "4-2": "Team members. Use `expand=members` to see user names. Objects properties described [here](http://developer.mixmax.com/docs/get-teams-id-members-coming-soon)", "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" }, "cols": 3, "rows": 5 } [/block] For response format, see [/teams](http://developer.mixmax.com/docs/teams).

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