GEgetdbt
Users

GET /api/v3/accounts/{account_id}/users/

Changed on

List users for a given account.

Request

  • Base URL
    https://cloud.getdbt.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Query parameters

group_idinteger

Filter by group id.

include_relatedstring

Comma-separated list of related objects to include in the response.

license_type'analyst' | 'developer' | 'it' | 'read_only'

Filter by license type.

limitinteger
offsetinteger
omit_permissions'0' | '1'

When set to "1" (recommended), group permissions and permission statements are omitted from the response.

order_by'-created_at' | '-date_joined' | '-email' | '-email_verified' | '-first_name' | '-id' | '-last_login' | '-last_name' | '-license_type' | '-pk' | '-scim_managed' | '-updated_at' | '-username' | 'created_at' | 'date_joined' | 'email' | 'email_verified' | 'first_name' | 'id' | 'last_login' | 'last_name' | 'license_type' | 'pk' | 'scim_managed' | 'updated_at' | 'username'
pkinteger

Filter by primary key (id).

pk__instring

Filter by primary keys (ids), as serialized JSON, e.g., [1,2,3]. Overrides "pk".

searchstring

Case insensitive substring search in email, first_name, last_name, or full name.

Response

Example response

{
  "data": [
    {
      "permissions": [
        {
          "state": 1
        }
      ]
    }
  ]
}

Changes

  • v3665e2f199a5fRevision changes
    • info

      added the new optional query request parameter group_id

    • info

      added the new optional query request parameter license_type

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter omit_permissions

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter pk

    • info

      added the new optional query request parameter pk__in

    • info

      added the new optional query request parameter search

  • v37d5c1b4c8d8aRevision changes
    • breaking

      for the path request parameter account_id, the format changed from no format to int64