End Users

List End Users

Get a list of end users in the organization.

get/api/v1/end-users

Request

  • Base URL: https://api.fordefi.com
  • URL: https://api.fordefi.com/api/v1/end-users
  • Auth: HTTP bearer

Query parameters

sort_byEndUserSortableFields[]
include_countboolean
pageinteger

The page number to fetch.

sizeinteger

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

user_idsstring[]

The unique identifiers of the users.

external_idsstring[]

The external IDs of the users.

Response

Successful Response

totalinteger
pageinteger required
sizeinteger required

Example response

{
  "end_users": [
    {
      "external_id": "user|1234"
    }
  ]
}

Changes

No recorded changes to this operation across all 23 revisions of this API.