Skip to main content
Retrieve a list of users in a specific organization.
External DocumentationTo learn more, visit the Atlassian Organizations documentation.

​
Basic Parameters

ParameterDescription
Account IDsSelect the user account IDs to filter the results by. Maximum of 10 account IDs can be provided.
CursorA token used to specify a results page. This value can be obtained from the links.next property from a previous response.
Directory IDThe unique ID associated with a directory.

Note: Use the - character to retrieve all directories.
Directory IDsSelect the directory IDs to filter by. Maximum of 10 directory IDs can be provided.

Note: The requestor must have administrative permissions for all resources linked to these directories.
Group IDsSelect the group IDs to filter results by. Maximum of 10 group IDs can be provided.
LimitThe maximum number of results to return per page. Maximum value is 100.
Organization IDThe unique ID of your organization.

Can be obtained by using the List Organizations action.
Resource IDsA comma-separated list of resource IDs in Atlassian Resource Identifier (ARI) format to filter results by. Maximum of 20 resource IDs can be provided.

For Example: ari:cloud:jira-core::site/1.
Return All PagesAutomatically fetch all resources, page by page.
Role IDsThe role IDs to filter results by.

​
Advanced Parameters

ParameterDescription
Account StatusThe lifecycle status of the Atlassian account to filter by.

* Active - the account is active and can be used.
* Inactive - the account is inactive and doesn’t have access to any resources.
* Closed - the account is closed and can’t be used.
Claim StatusThe user claim status to filter by. If empty, returns all users regardless of claim status.

* managed returns users claimed by the organization.
* unmanaged returns users not yet claimed.

For more information about managed accounts, refer to the Organizations API documentation
Email DomainsA comma-separated list of email domains to filter by. Maximum of 10 email domains can be provided.

Note: Only include the domain, for example: example.com.
MFA EnabledSelect to filter users by whether they have multi-factor authentication enabled.
Membership StatusThe membership status of the user account in the organization to filter by.

* Active - the account has an active membership for one or more directories.
* Suspended - the account is suspended in ALL directories.
* No Membership - the account is in NONE of the organization’s directories.
Search TermA search term to filter users by their nickname or email.
Sort ByThe field and direction to sort the results by. Currently, only sorting by nick_name is supported.

Available directions: asc, desc

Note: If not provided, asc will be used.

For Example:
[
  {
    “field”: “nick_name”,
    “direction”: “asc”
  }
]
User StatusThe user status to filter by. Each status maps to a specific accountStatus + membershipStatus combination.

* Active - accountStatus: active + membershipStatus: active
* Suspended - accountStatus: active + membershipStatus: suspended
* Not Invited - accountStatus: active + membershipStatus: no_membership
* Deactivated - accountStatus: inactive
* For Deletion - managed account scheduled for deletion

Note: Do not combine status with conflicting Account Status or Membership Status Parameters.

​
Example Output

{
	"data": [
		{
			"accountId": "12345678-1234-1234-1234-123456789012",
			"accountType": "atlassian",
			"status": "active",
			"accountStatus": "active",
			"membershipStatus": "active",
			"addedToOrg": "2024-01-01T00:00:00.000Z",
			"name": "John Doe",
			"nickname": "Jonny",
			"email": "email@example.com",
			"emailVerified": true,
			"claimStatus": "unmanaged",
			"platformRoles": [
				"atlassian/org-admin"
			],
			"picture": "https://picture.example.com/picture.png",
			"avatar": "https://avatar.example.com/avatar.png",
			"managementSource": "invited",
			"mfaEnabled": true,
			"jobTitle": "Senior Business Analyst",
			"department": "Human Resources",
			"organization": "Talent",
			"location": "New York",
			"timeZone": "America/New_York",
			"counts": {
				"resources": 10
			},
			"links": {
				"self": "ECg53CukK1twBo0LK1u9nw"
			}
		}
	],
	"links": {
		"self": "ObSbZxpM1f1fzia2_GnuJw",
		"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
		"next": "kloHX1ZQVasDAkx_P48NYQ"
	}
}

​
Workflow Library Example

List Organization Users with Atlassian Organizations and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop