PRprobely
API Users

List API Users

Changed on
get/api-users/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/api-users/
  • Auth
    API key in header Authorization

Query parameters

accountboolean
activeboolean
creatorstring[]

Filter API users by their creator. It will include API users created by other API users in the same chain too.

excludestring[]

Fields to exclude from the response.

exclude_targetstring[]
exclude_teamstring[]
labelstring[]

A unique Base58 value identifying this object.

label_logical_operator'and' | 'or'

Logical operator to apply between user labels:
(Defaults to or)

  • and - and
  • or - or
lengthinteger

Number of results to return per page.

mfa_enabledboolean
no_accessboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

rolestring[]

A unique Base58 value identifying this object.

searchstring

A search term.

targetstring[]
teamstring[]

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}

Changes

  • 0e9b5b5da4d0Revision changes
    • info

      added the new optional query request parameter creator

    • info

      added the optional write-only property results/items/days_valid_for to the response with the status

    • info

      added the required property // to the response with the status

  • 8b8322107b18Revision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status