index.json 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. {
  2. "get": {
  3. "tags": ["Organizations"],
  4. "description": "Return a list of organizations available to the authenticated session. This is particularly useful for requests with an user bound context. For API key based requests this will only return the organization that belongs to the key.",
  5. "operationId": "List Your Organizations",
  6. "parameters": [
  7. {
  8. "name": "owner",
  9. "in": "query",
  10. "description": "Restrict results to organizations in which you are an organization owner.",
  11. "schema": {
  12. "type": "boolean"
  13. }
  14. },
  15. {
  16. "$ref": "../../components/parameters/pagination-cursor.json#/PaginationCursor"
  17. }
  18. ],
  19. "responses": {
  20. "200": {
  21. "description": "Success",
  22. "content": {
  23. "application/json": {
  24. "schema": {
  25. "type": "array",
  26. "items": {
  27. "$ref": "../../components/schemas/organization.json#/Organization"
  28. }
  29. },
  30. "example": [
  31. {
  32. "avatar": {
  33. "avatarType": "letter_avatar",
  34. "avatarUuid": null
  35. },
  36. "dateCreated": "2018-11-06T21:19:55.101Z",
  37. "id": "2",
  38. "isEarlyAdopter": false,
  39. "name": "The Interstellar Jurisdiction",
  40. "require2FA": false,
  41. "slug": "the-interstellar-jurisdiction",
  42. "status": {
  43. "id": "active",
  44. "name": "active"
  45. }
  46. }
  47. ]
  48. }
  49. }
  50. },
  51. "401": {
  52. "description": "Unauthorized"
  53. },
  54. "403": {
  55. "description": "Forbidden"
  56. }
  57. },
  58. "security": [
  59. {
  60. "auth_token": ["org: read"]
  61. }
  62. ]
  63. }
  64. }