Export directory users to CSV

curl --request POST \ --url https://api.wirespeed.co/v1/directory/export/csv \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "size": 123, "page": 123, "search": "<string>", "orderBy": "<string>", "searchAttributeKey": "<string>", "teamId": "<string>", "groups": [], "ipId": "<string>", "endpointId": "<string>", "endpointPrivateIpId": "<string>", "userAgentId": "<string>", "showUnmanagedUsers": true, "onlyEnabled": true, "onlyDisabled": true, "onlyContained": true, "onlyChatOpsOnboardingUsers": true, "integrationIds": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "groupIds": [ "<string>" ], "dedupeCanonicalRoots": true, "onlyCanonicalClustersWithDuplicates": true, "canonicalClusterOfDirectoryUserId": "<string>" } '

Authorizations

Authorization

string

header

required

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

Body

application/json

size

number

page

number

filter

enum<string>

Field to filter directory users by

Available options:

email,

name,

username,

title,

department,

role,

integration_source_id,

custom_attribute

string

orderBy

string

orderDir

enum<string>

Available options:

asc,

desc

searchAttributeKey

string

Custom attribute key to match when filter is custom_attribute. When omitted, searches across all attribute keys and values.

teamId

string

Filter users by team ID (for service providers)

groups

enum<string>[]

Filter users by groups

Available options:

VIP,

ADMIN,

EXTERNAL,

TECHNICAL,

FINANCIAL,

NHI

ipId

string

Filter users associated with specific IP address

endpointId

string

Filter users associated with specific endpoint

endpointPrivateIpId

string

Filter users associated with endpoints that have this private IP address

userAgentId

string

Filter users associated with specific user agent

showUnmanagedUsers

boolean

Include unmanaged users in results

onlyEnabled

boolean

Only include users that are enabled

onlyDisabled

boolean

Only include users that are disabled

onlyContained

boolean

Only include users that are contained

onlyChatOpsOnboardingUsers

boolean

Only include users that are in the chat ops onboarding group

smsEnrollmentStatus

enum<string>

Filter users by SMS enrollment status

Available options:

enrolled,

pending,

max_attempts,

opted_out,

not_invited

integrationIds

string<uuid>[]

Filter users by integration IDs (sources)

groupIds

string[]

Filter users by group IDs (supports multiple). Pass the sentinel value "ungrouped" to filter users with no group memberships.

groupFilterOperator

enum<string>

Operator for combining multiple group filters. "and" = must be in ALL groups, "or" = must be in ANY group. Defaults to "or".

Available options:

and,

or

dedupeCanonicalRoots

boolean

When true and asset deduplication is enabled for the team, return only canonical representative rows (canonical_id IS NULL)

onlyCanonicalClustersWithDuplicates

boolean

When true together with dedupeCanonicalRoots and asset deduplication, return only canonical roots that have at least one merged duplicate from another source

canonicalClusterOfDirectoryUserId

string

When set with asset deduplication enabled, return paginated directory user rows in this canonical cluster (children only; resolves root from root or child id)

Response

CSV export of directory users

The response is of type file.