List All Users

Returns a list of all users within your Fivetran account.

Request schema

Query parameters

cursor

string

Paging cursor, read more about pagination

example:

cursor_value

limit

integer

Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

format:

int32

example:

100

active

boolean

Indicates whether to return only enabled users (true) or not (false). By default, both enabled (allowed to log in) and suspended users are returned.

example:

true

user_type

string

The type of user. Possible values: REGULAR_USER: A human user who can log in to the Fivetran dashboard and interact with the API, and SERVICE_ACCOUNT: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.

example:

SERVICE_ACCOUNT

has_api_key

string

Indicates whether the user has an assigned API key, including expired keys. Accepted values: true or false.

example:

true

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/users

GET /v1/users?cursor=cursor_value&limit=100&active=true&user_type=SERVICE_ACCOUNT&has_api_key=true HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Users list retrieved successfully

data

undefinedrequired

items

arrayrequired

The collection of returned items

stringrequired

The unique identifier for the user within the Fivetran system.

example:

user_id

stringrequired

The email address that the user has associated with their user profile. Optional for service accounts (user_type: SERVICE_ACCOUNT).

example:

user@email.value

verified

booleanrequired

The field indicates whether the user has verified their email address in the account creation process.

example:

true

invited

boolean

The field indicates whether the user has been invited to your account.

example:

true

picture

string

The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')

example:

AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==

phone

string

The phone number of the user.

example:

+1234567890

role

stringrequired

The role that you would like to assign to the user

example:

Account Administrator

active

booleanrequired

The field indicates if the user is an active Fivetran account user.

example:

true

given_name

string

The first name of the user.

example:

John

family_name

string

The last name of the user.

example:

Doe

logged_in_at

stringrequired

The last time that the user has logged into their Fivetran account.

format:

date-time

example:

2024-01-01T00:00:00Z

created_at

stringrequired

The timestamp that the user created their Fivetran account

format:

date-time

example:

2024-01-01T00:00:00Z

user_type

string

enum:

"REGULAR_USER""SERVICE_ACCOUNT"

has_api_key

boolean

Indicates whether the user has an assigned API key, including expired keys. Accepted values: true or false.

example:

true

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Users list retrieved successfully",
  "data": {
    "items": [
      {
        "id": "user_id",
        "email": "user@email.value",
        "verified": true,
        "invited": true,
        "picture": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==",
        "phone": "+1234567890",
        "role": "Account Administrator",
        "active": true,
        "given_name": "John",
        "family_name": "Doe",
        "logged_in_at": "2024-01-01T00:00:00Z",
        "created_at": "2024-01-01T00:00:00Z",
        "user_type": "SERVICE_ACCOUNT",
        "has_api_key": true
      }
    ],
    "next_cursor": "cursor_value"
  }
}

The user_type and has_api_key query parameters are in Private Preview. To enable them for your account, contact our support team.