List employees

GET https://getokta.io/api/apps/employees/directory

Employee directory.

  • Rate Limit: LIGHT
    How heavily this call counts against your quota: LIGHT < MODERATE < HEAVY.
  • Permission needed: employees.directory.read
    The scope the tenant must grant your app before this call is allowed.
  • Reference Code: srv_c6a4
    A stable identifier for this endpoint — quote it to support to speed up tracing.

Query Params

page integer

Page number (1-based).

per_page integer

Items per page (max 100).

search string

Optional free-text search.

entities string

Up to 20 comma-separated ULIDs of entities beneath yours: the answer is {"entities": {"<ulid>": this endpoint’s answer for that entity}}, a refused one carrying error and status under its key. A school is read with its own grant to your app or your entity’s read grant carried down; entity.hierarchy.read is required.

entity string

ULID of ONE entity beneath yours: the answer is that entity’s, as is. For a person holding tenants.children.view_members, never an installation token.