List Identities

get

https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/identity

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

number

required

Query Params

limit

number

≤ 200

Limit the number of results returned. Maximum 200.

cursor

string

Cursor to paginate through results.

managementTypes

array of objects

Filter results by management type. Accepts multiple options.

managementTypes

types

array of objects

Filter results by type. Accepts multiple options.

types

statuses

array of objects

Filter results by status. Accepts multiple options.

statuses

companies

array of strings

Filter results by companies. Accepts multiple options.

companies

departments

array of strings

Filter results by departments. Accepts multiple options.

departments

locations

array of strings

Filter results by locations. Accepts multiple options.

locations

keyword

string

Filter results by username, identityId, department name, email or displayName (prefix search).

contractStartRange

string

Filter results by contract start date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

contractEndRange

string

Filter results by contract end date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

createdAtRange

string

Filter results by created date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

updatedAtRange

string

Filter results by updated date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

sortBy

string

enum

Sort results by a specific field.

sortOrder

string

enum

Sort results in ascending or descending order. Defaults to ASC.

Allowed:

expands

array of objects

Expand other datasets when fetching identities. Accepts multiple options.

expands

alertTypes

array of objects

Filter result by alert type. Accepts multiple options.

alertTypes

managerId

string

Filter results by managerId.

serviceId

string

Filter results by serviceId.

hasHRM

boolean

Filter results by HRM (employee master) linkage. When true, returns only UIDs with HRM linkage. When not provided, no filtering is applied.

haveAssignedDevice

boolean

Filter results by identities that have at least one assigned device

haveSaasAccount

boolean

Filter results by identities that have at least one SaaS account

Responses

418

The feature isn't available for the organization. Please contact the support team.