List portal users

1 min

GET

https://api.detected.app/api/v2/public/portal-users

Returns the portal users in your account. Use the query parameters to filter the results.

This endpoint is paginated. Use the page parameter to request further pages. The meta and links objects in the response describe the current page and link to the others.

order_bystringDirection to sort the results in: <code>asc</code> for ascending or <code>desc</code> for descending. Use it together with <code>sort_by</code>; it has no effect if <code>sort_by</code> is omitted. The default is <code>asc</code>.

sort_bystringThe field to sort the results by. Use it together with <code>order_by</code> to choose the direction; if <code>order_by</code> is omitted, results are sorted in ascending order (<code>asc</code>). If <code>sort_by</code> is omitted, results are returned in no guaranteed order. Supported fields: <ul> <li><code>email</code></li> <li><code>name</code></li> <li><code>id</code></li> <li><code>profile_id</code></li> </ul>

pagestringPage number of the results to return, starting from 1. The number of items per page is returned in <code>meta.per_page</code>.

idstringFilter by portal user ID. If a match is found, only that portal user is returned.

namestringFilter by portal user name.

emailstringFilter by portal user email address.

profile_idstringFilter by the ID of a profile the portal user is assigned to.

acceptstringGenerated from available response content types

200OK

401Unauthorized. The access token is missing, invalid or has expired.

429Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.

curl --request GET \
     --url https://api.detected.app/api/v2/public/portal-users \
     --header 'accept: application/json'

Have a question?

Our knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.