v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB
End Users

Search end users

Search for end users.

get/end-users

Query parameters

namestring

End user name. You can use a partial name.

sort'name' | 'created' | 'updated'

Sort by one field

order'asc' | 'desc'

Sort order (ascending or descending)

offsetinteger

Offset index (zero-based)

Search offset index (zero-based)

limitinteger

Limit search results

Example:20

Number of items to return

Response

Search results

offsetinteger required

Offset index (zero-based)

totalinteger required
hasMoreboolean required

Whether there are more results available

Example response

{
  "total": 20,
  "hits": [
    {
      "name": "French Corp",
      "address": {
        "country": "FR",
        "city": "Paris"
      },
      "comment": "French Subsidiary",
      "sid": "callrsid",
      "type": "third-party",
      "created": "2024-04-24T17:42:28Z",
      "updated": "2024-04-24T17:42:28Z",
      "deletable": true
    }
  ]
}