Skip to main content
GET
/
directory
/
{id}
Get directory user by ID
curl --request GET \
  --url https://api.wirespeed.co/directory/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "displayName": "<string>",
  "teamId": "<string>",
  "enabled": true,
  "directoryId": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "previousPhoneNumber": "<string>",
  "title": "<string>",
  "email": "<string>",
  "additionalEmails": [
    "<string>"
  ],
  "allEmails": [
    "<string>"
  ],
  "vip": true,
  "nhi": true,
  "financial": true,
  "technical": true,
  "managerDirectoryId": "<string>",
  "managerEmail": "<string>",
  "domain": "<string>",
  "department": "<string>",
  "createdAt": "<string>",
  "integrationId": {},
  "roles": [
    "<string>"
  ],
  "lastCredentialExposure": {},
  "credentialsExposed": true,
  "numberCredentialExposures": 123,
  "lastCheckedForCredentialExposures": {},
  "needsChatOpsWelcome": true,
  "contained": true,
  "username": "<string>",
  "containable": true,
  "smsConsentReceivedAt": {},
  "administrator": true,
  "updatedAt": "<string>",
  "passwordLastChangedAt": "<string>",
  "lastSignInAt": "<string>",
  "raw": {},
  "tags": [
    {
      "id": "<string>",
      "directoryUserId": "<string>",
      "tag": "VIP",
      "automationId": "<string>",
      "teamId": "<string>",
      "overriddenByUser": true,
      "enabled": true,
      "createdAt": "<string>"
    }
  ],
  "managed": true,
  "chatOpsOnboardingUser": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Directory user ID

Response

id
string
required

Unique identifier for the directory user

displayName
string
required

Display name for the user

teamId
string
required

Team ID that owns this user

additionalEmails
string[]
required

Additional email addresses of the user

allEmails
string[]
required

All email addresses of the user (primary + additional)

createdAt
string
required

Timestamp when the user was created

integrationId
object
required

ID of the integration this user came from

roles
string[]
required

Roles assigned to the user

credentialsExposed
boolean
required

Whether the user's credentials have been exposed

numberCredentialExposures
number
required

Number of times user credentials have been exposed

containable
boolean
required

Whether the user can be contained via automation

tags
object[]
required

Tags assigned to this user

enabled
boolean

Whether the user account is enabled

directoryId
string

Directory-specific identifier for the user

name
string

Full name of the user

phoneNumber
string

Phone number of the user

previousPhoneNumber
string

Previous phone number if changed

title
string

Job title of the user

email
string

Email address of the user

vip
boolean

Whether the user is marked as VIP

nhi
boolean

Whether the user is non-human identity (service account)

financial
boolean

Whether the user has financial access/permissions

technical
boolean

Whether the user has technical access/permissions

managerDirectoryId
string

Directory ID of the user's manager

managerEmail
string

Email address of the user's manager

domain
string

Domain the user belongs to

department
string

Department the user works in

lastCredentialExposure
object

Timestamp of the last credential exposure

lastCheckedForCredentialExposures
object

Timestamp when last checked for credential exposures

needsChatOpsWelcome
boolean

Whether user needs to receive chat operations welcome message

contained
boolean

Whether the user is currently contained

username
string

Username for the user account

Timestamp when SMS consent was received

administrator
boolean

Whether the user has administrative privileges

updatedAt
string

Timestamp when the user was last updated

passwordLastChangedAt
string

Timestamp when password was last changed

lastSignInAt
string

Timestamp of the user's last sign-in

raw
object

Raw data from the directory source

managed
boolean

Whether the user is managed by an integration

chatOpsOnboardingUser
boolean

Whether the user is in the chat ops onboarding group

I