List API Users

GET 
/api-users/

Request

Query Parameters

account boolean
active boolean
exclude string[]

Fields to exclude from the response.

exclude_target string[]
exclude_team string[]
label string[]

A unique Base58 value identifying this object.

label_logical_operator string
Possible values: [and, or]
Logical operator to apply between user labels.
• and - and
• or - or
length integerrequired

Number of results to return per page.

mfa_enabled boolean
no_access boolean
ordering stringrequired

Which field to use when ordering the results.

page integerrequired

A page number within the paginated result set.

role string[]

A unique Base58 value identifying this object.

search stringrequired

A search term.

target string[]
team string[]

Responses

200

application/json

Schema

Schema

count integerrequired

Total number of results.

page_total integerrequired

Total number of pages.

page integerrequired

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

length integerrequired

Number of results returned per page.

results object[]
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
active booleanrequired
Default value: true
If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.
labels object[]required
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$
Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
]
user_roles object[]
Roles of the user.
Array [
id stringrequired
A unique Base58 value identifying this object.
role objectrequired
Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in to_internal_value.
This is for the drf-spectacular documentation generation.
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Role's name.
scope objectrequired
tier stringrequired
target object
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
url urirequired
Target URL.
team object
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
]
is_apiuser booleanrequired
If true, it is an app that interacts with Probely through the API.
If false, it is a human who interacts with Probely through our web interface.
Defaults to false."
key stringrequired
]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-09-10T15:58:28.957Z",
      "active": true,
      "labels": [
        {
          "id": "string",
          "name": "string",
          "color": "string",
          "changed_by": {
            "id": "string",
            "email": "[email protected]",
            "name": "string"
          },
          "changed": "2024-09-10T15:58:28.957Z"
        }
      ],
      "user_roles": [
        {
          "id": "string",
          "role": {
            "id": "string",
            "name": "string"
          },
          "scope": {
            "tier": "string",
            "target": {
              "id": "string",
              "name": "string",
              "url": "string"
            },
            "team": {
              "id": "string",
              "name": "string"
            }
          }
        }
      ],
      "is_apiuser": true,
      "key": "string"
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...