Get multiple users using ids
GET {{baseUrl}}/api/user/bulk?accountId=<string>&expand=<string>&expand=<string>&limit=<integer>
Returns user details for the ids provided in request.
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
accountId | string | (Required) A list of accountId's of users to be returned. | |
expand | string | A multi-value parameter indicating which properties of the user to | |
expand. |
-
operations
returns the operations that the user is allowed to do. -
details.personal
returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
details.business
returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
personalSpace returns the user's personal space, if it exists. | |
expand
| string | | A multi-value parameter indicating which properties of the user to expand. -
operations
returns the operations that the user is allowed to do. -
details.personal
returns the 'Personal' details in the user's profile, like the 'Email' and 'Phone'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
details.business
returns the 'Company' details in the user's profile, like the 'Position' and 'Department'. Note that these fields have been deprecated due to privacy changes. See the migration guide for details. -
personalSpace returns the user's personal space, if it exists. | |
limit
| string | | The maximum number of results returned. Currently API returns 200 results max. If more that 200 ids are passed first 200 will be returned. |
RESPONSES
status: OK
{"results":[{"type":"user","accountId":"elit est ullamco in officia","accountType":"exercitation fugiat labo","email":"Excepteur in cillum officia","publicName":"ullamco occaecat","profilePicture":{"path":"cupidatat dolore et labore ad","width":-99848841,"height":55035562,"isDefault":true},"displayName":"amet","_expandable":{"operations":"labore ut Duis id culpa","details":"in irure voluptate Duis magna","personalSpace":"n"},"_links":{},"username":"est sunt dolor nostrud","userKey":"labo","operations":[{"operation":"update","targetType":"attachment"},{"operation":"administer","targetType":"attachment"}],"details":{"business":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"personal":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"personalSpace":{"id":-93610124,"key":"in eiusmod","name":"ut minim Excepteur","type":"sunt qui amet","status":"null","_expandable":{"settings":"pariatur deserunt anim","metadata":"anim occaecat aliqua","operations":"aute nostrud in","lookAndFeel":"est irure aute labore","permissions":"in cupidatat qui","icon":"voluptate Duis","description":"culpa veniam Lorem velit","theme":"consequat sunt reprehenderit","history":"ex officia veniam sit do","homepage":"dolore dolore"},"_links":{},"icon":{"path":"dolore Lorem magna sunt","width":3933679,"height":-17426468,"isDefault":false},"description":{"plain":{"value":"consequat consectetur laborum labore occaecat","representation":"view","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"view":{"value":"Duis reprehenderit anim ut","representation":"view","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},"homepage":{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},"metadata":{"labels":{"results":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"start":23981894,"limit":-68365223,"size":-97521792,"_links":{}}},"operations":[{"operation":"administer","targetType":"blogpost"},{"operation":"delete","targetType":"blogpost"}],"permissions":[{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"read","targetType":"space"},"anonymousAccess":false,"unlicensedAccess":false},{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"restore","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"settings":{"routeOverrideEnabled":true,"_links":{}},"theme":{},"lookAndFeel":{"headings":{"color":"\u003cstring\u003e"},"links":{"color":"\u003cstring\u003e"},"menus":{"hoverOrFocus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"color":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"header":{"backgroundColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"button":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"secondaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"search":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"content":{"screen":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"container":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"header":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"body":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"bordersAndDividers":{"color":"\u003cstring\u003e"}},"history":{"createdDate":"2004-03-14T14:56:20.738Z"}}},{"type":"user","accountId":"aliquip ex aute occaecat minim","accountType":"cupidatat dolore","email":"tempor non","publicName":"Lorem","profilePicture":{"path":"fugiat ex sit sunt","width":86996840,"height":-45552232,"isDefault":false},"displayName":"eu qui mollit","_expandable":{"operations":"laborum dolor magna adipisicing","details":"culpa quis a","personalSpace":"id in"},"_links":{},"username":"proident minim et ipsum","userKey":"est conseq","operations":[{"operation":"copy","targetType":"comment"},{"operation":"purge_version","targetType":"application"}],"details":{"business":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"personal":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"personalSpace":{"id":-77236660,"key":"mollit","name":"mollit reprehenderit","type":"ipsum eu","status":"id magna esse","_expandable":{"settings":"Lorem cupidatat fugiat id","metadata":"ut non","operations":"m","lookAndFeel":"elit ","permissions":"proident labore","icon":"ut fugiat esse do","description":"sunt","theme":"ea consequat aliqua","history":"ullamco culpa","homepage":"eu esse ut amet"},"_links":{},"icon":{"path":"laborum magna Dui","width":-87940522,"height":-74576861,"isDefault":true},"description":{"plain":{"value":"adipisicing proident magna nulla","representation":"view","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},"view":{"value":"quis enim ex adipisicing","representation":"plain","embeddedContent":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},"homepage":{"value":"\u003cCircular reference to #/components/schemas/Content detected\u003e"},"metadata":{"labels":{"results":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"start":12150462,"limit":-13231996,"size":-79881326,"_links":{}}},"operations":[{"operation":"create","targetType":"page"},{"operation":"update","targetType":"blogpost"}],"permissions":[{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"purge","targetType":"attachment"},"anonymousAccess":false,"unlicensedAccess":false},{"subjects":{"_expandable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"user":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"group":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"operation":{"operation":"delete","targetType":"application"},"anonymousAccess":false,"unlicensedAccess":false}],"settings":{"routeOverrideEnabled":true,"_links":{}},"theme":{},"lookAndFeel":{"headings":{"color":"\u003cstring\u003e"},"links":{"color":"\u003cstring\u003e"},"menus":{"hoverOrFocus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"color":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"header":{"backgroundColor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"button":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"primaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"secondaryNavigation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"search":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"content":{"screen":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"container":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"header":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"body":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"bordersAndDividers":{"color":"\u003cstring\u003e"}},"history":{"createdDate":"1965-11-18T11:33:14.736Z"}}}],"start":-77819495,"limit":-88196390,"size":-80415169,"_links":{}}