OFofficernd
Users

Get user

Resolve a user id, such as the value of createdBy or modifiedBy, to the user's name, email and linked member. Only users with a role in the organization are resolved. Unknown ids, system or integration users and users from other organizations return 404 User not found. Treat both a null id and a 404 as "System / unknown user".

Required scopes: flex.user.profile.read

get/api/v2/organizations/{orgSlug}/users/{userId}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/users/{userId}
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.user.profile.read

Path parameters

userIdstring required

The user id, as found in createdBy / modifiedBy.

orgSlugstring required

organization slug

Response

_idstring

The _id of the user.

namestring

The display name of the user.

emailstring

The user's primary login email. Omitted when the user has no email.

memberstring nullable

The _id of the member linked to the user in this organization, or null when the user has no linked member.

Example response

{
  "_id": "603dfbc260f4054084125d33",
  "name": "John Doe",
  "email": "john.doe@email.com",
  "member": "603dfbc260f4054084125d30"
}

Changes

No recorded changes to this operation across all 1 revision of this API.