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:

af3gu4hSDdF

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

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=af3gu4hSDdF&limit=100&active=SOME_BOOLEAN_VALUE HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com

Responses

200

Successful response

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

items

arrayrequired

The collection of returned items

stringrequired

The unique identifier for the group within the Fivetran system.

example:

user_id

stringrequired

The email address that the user has associated with their user profile.

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.

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:

AFg65aoa7af4r3feaAa6bi7sfgse== ... base64 encoded image

phone

string

The phone number of the user.

example:

+1234567890

role

stringrequired

The group role that you would like to assign this new user to. Supported group roles: ‘Destination Administrator‘, ‘Destination Reviewer‘, ‘Destination Analyst‘, ‘Connector Creator‘, or a custom destination role

example:

Account Administrator

active

booleanrequired

The boolean value indicating the user's status. If the user is able to log in, the value is true. If the user's account has been suspended, the value is false

example:

true

given_name

string

The first name of the user.

example:

John

created_at

stringrequired

The timestamp of when the group was created in your account.

format:

date-time

example:

2024-01-01T00:00:00Z

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

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "items": [
      {
        "id": "user_id",
        "email": "user@email.value",
        "verified": true,
        "invited": false,
        "picture": "AFg65aoa7af4r3feaAa6bi7sfgse== ... base64 encoded image",
        "phone": "+1234567890",
        "role": "Account Administrator",
        "active": true,
        "given_name": "John",
        "created_at": "2024-01-01T00:00:00Z",
        "family_name": "Doe",
        "logged_in_at": "2024-01-01T00:00:00Z"
      }
    ],
    "next_cursor": "cursor_value"
  }
}