Skip to main content
Retrieve a list of directories in an organization that match the supplied parameters.
External DocumentationTo learn more, visit the Atlassian Organizations documentation.

​
Basic Parameters

ParameterDescription
Account IDThe unique ID of the user account.

Can be obtained by using the List Organization Users action.
CursorA token used to specify a results page. This value can be obtained from the links.next property from a previous response.
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.
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.
Return All PagesAutomatically fetch all resources, page by page.

​
Advanced Parameters

ParameterDescription
Search TermFilter results by the value of the name property.

​
Example Output

{
	"data": [
		{
			"directoryId": "12345678-1234-1234-1234-123456789012",
			"name": "Primary Directory",
			"icon": "https://icon1.example.com/icon1.png"
		},
		{
			"directoryId": "12345678-1234-1234-1234-123456789013",
			"name": "Secondary Directory",
			"icon": "https://icon2.example.com/icon2.png"
		}
	],
	"links": {
		"self": "ObSbZxpM1f1fzia2_GnuJw",
		"prev": "LIZFEbzCT2pCCkQhPIUgIQ",
		"next": "kloHX1ZQVasDAkx_P48NYQ"
	}
}

​
Workflow Library Example

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