CLcloudblue
User

GET /users

Changed on

Request

  • Base URL
    https://api.connect.cloudblue.com/public/v1
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

domain.auth.enforceboolean

Filter for: domain.auth.enforce

lookups: eq, ne

domain.auth.idp.idstring

Filter for: domain.auth.idp.id

lookups: eq, ne, like, ilike, null, in, out

domain.idstring

Filter for: domain.id

lookups: eq, ne, like, ilike, null, in, out

emailstring

Filter for: email

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

events.activated.atstring date-time

Filter for: events.activated.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.invited.atstring date-time

Filter for: events.invited.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.signed.atstring date-time

Filter for: events.signed.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

external_idstring

Filter for: external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

groups.idstring

Filter for: groups.id

lookups: eq, ne, like, ilike, null, in, out

groups.namestring

Filter for: groups.name

lookups: eq, ne, like, ilike, in, out

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

idp.idstring

Filter for: idp.id

lookups: eq, ne, like, ilike, null, in, out

namestring

Filter for: name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

permissionsstring

Filter for: permissions

lookups: eq, ne, like, ilike, in, out

default: hidden

statusstring

Filter for: status

lookups: eq, in

tags.idstring

Filter for: tags.id

lookups: eq, ne, like, ilike, null, in, out

tags.namestring

Filter for: tags.name

lookups: eq, ne, like, ilike, in, out

Response

idstring
namestring
iconstring
external_idstring
emailstring email
activeboolean
notificationsboolean
announcementsboolean
blocklistedboolean
regionstring
timeformatstring
timezonestring
statusstring
activation_codestring

Changes

  • 2de715cbd1f3Revision 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

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the media type application/json for the response with the 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 optional property // to the response with the 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

  • 22a697bcb678Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

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

    • breaking

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

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      api tag User added

    • info

      api tag Accounts removed