List organization members | Management API Reference

List members of an organization

get/v2/organizations/{slug}/members

Returns a cursor-paginated list of organization members including their roles and project-scoped permissions.

OAuth scopes

organizations:read

The fine-grained token must include the following permissions to access this endpoint:

members_read

Path parameters

slug
Required
string
Organization slug

Query parameters

page
Optional
object
filter
Optional
object

Response codes

Response (200)

1
{
2
  "data": [
3
    {
4
      "type": "organization_member",
5
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
6
      "attributes": {
7
        "username": "lorem",
8
        "primary_email": "lorem",
9
        "mfa_enabled": true,
10
        "is_sso_user": true,
11
        "avatar_url": "lorem",
12
        "roles": [
13
          {
14
            "name": "developer",
15
            "scope": "organization",
16
            "projects": [
17
              {
18
                "ref": "lorem",
19
                "name": "lorem"
20
              }
21
            ]
22
          }
23
        ]
24
      }
25
    }
26
  ],
27
  "links": {
28
    "first": "/v2/organizations/my-org/members?page[size]=10",
29
    "prev": "/v2/organizations/my-org/members?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
30
    "next": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
31
    "last": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
32
  }
33
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "type": {
10
            "type": "string",
11
            "description": "Resource type.",
12
            "enum": [
13
              "organization_member"
14
            ]
15
          },
16
          "id": {
17
            "type": "string",
18
            "format": "uuid",
19
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
20
          },
21
          "attributes": {
22
            "type": "object",
23
            "properties": {
24
              "username": {
25
                "type": "string",
26
                "description": "Member's username",
27
                "nullable": true
28
              },
29
              "primary_email": {
30
                "type": "string",
31
                "description": "Member's primary email",
32
                "nullable": true
33
              },
34
              "mfa_enabled": {
35
                "type": "boolean",
36
                "description": "Whether Multi-Factor Authentication is enabled for this member"
37
              },
38
              "is_sso_user": {
39
                "type": "boolean",
40
                "description": "Whether this member is a Single Sign-On user"
41
              },
42
              "avatar_url": {
43
                "type": "string",
44
                "description": "Member's avatar URL",
45
                "nullable": true
46
              },
47
              "roles": {
48
                "type": "array",
49
                "items": {
50
                  "type": "object",
51
                  "properties": {
52
                    "name": {
53
                      "type": "string",
54
                      "description": "Role name. For project-scoped roles this is the base role name.",
55
                      "example": "developer"
56
                    },
57
                    "scope": {
58
                      "type": "string",
59
                      "enum": [
60
                        "organization",
61
                        "project"
62
                      ],
63
                      "description": "Whether this role applies org-wide or is scoped to specific projects for the user."
64
                    },
65
                    "projects": {
66
                      "type": "array",
67
                      "items": {
68
                        "type": "object",
69
                        "properties": {
70
                          "ref": {
71
                            "type": "string"
72
                          },
73
                          "name": {
74
                            "type": "string"
75
                          }
76
                        },
77
                        "required": [
78
                          "ref",
79
                          "name"
80
                        ]
81
                      },
82
                      "description": "Project refs this role is scoped to. Empty array for org-level roles."
83
                    }
84
                  },
85
                  "required": [
86
                    "name",
87
                    "scope",
88
                    "projects"
89
                  ]
90
                },
91
                "description": "Roles assigned to this member. Includes both org-level and project-scoped roles."
92
              }
93
            },
94
            "required": [
95
              "username",
96
              "primary_email",
97
              "mfa_enabled",
98
              "is_sso_user",
99
              "avatar_url",
100
              "roles"
101
            ]
102
          }
103
        },
104
        "required": [
105
          "type",
106
          "id",
107
          "attributes"
108
        ]
109
      }
110
    },
111
    "links": {
112
      "type": "object",
113
      "properties": {
114
        "first": {
115
          "type": "string",
116
          "description": "URL path to the first page if available.",
117
          "example": "/v2/organizations/my-org/members?page[size]=10",
118
          "nullable": true
119
        },
120
        "prev": {
121
          "type": "string",
122
          "description": "URL path to the previous page.",
123
          "example": "/v2/organizations/my-org/members?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
124
          "nullable": true
125
        },
126
        "next": {
127
          "type": "string",
128
          "description": "URL path to the next page.",
129
          "example": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
130
          "nullable": true
131
        },
132
        "last": {
133
          "type": "string",
134
          "description": "URL path to the last page if available.",
135
          "example": "/v2/organizations/my-org/members?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295",
136
          "nullable": true
137
        }
138
      },
139
      "required": [
140
        "prev",
141
        "next"
142
      ]
143
    }
144
  },
145
  "required": [
146
    "data",
147
    "links"
148
  ]
149
}