List All API Keys Private Preview

Returns a paginated list of API keys for 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

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

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/api-keys

GET /v1/users/api-keys?cursor=cursor_value&limit=100&user_type=SERVICE_ACCOUNT 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:

API keys have been listed

data

undefinedrequired

items

arrayrequired

The collection of returned items

user_id

stringrequired

The unique identifier for the user within the Fivetran system.

example:

user_id

user_type

stringrequired

enum:

"REGULAR_USER""SERVICE_ACCOUNT"

key_value

stringrequired

The public identifier of the API key.

example:

key_abc123

created_at

stringrequired

The timestamp that the user created their API key

format:

date-time

example:

2024-01-01T00:00:00Z

key_status

stringrequired

The status of the API key. Possible values: ACTIVE: The key has a single active secret, ACTIVE_GRACE: The key has two active secrets during rotation overlap, and EXPIRED: The key has expired.

enum:

"ACTIVE""ACTIVE_GRACE""EXPIRED"

expires_at

string

The timestamp when the API key expires.

format:

date-time

example:

2024-04-01T00:00:00Z

overlap_expires_at

string

The timestamp when the previous secret expires after rotation. Only present during the overlap period.

format:

date-time

example:

2024-03-08T00:00:00Z

last_rotated_at

string

format:

date-time

next_cursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "API keys have been listed",
  "data": {
    "items": [
      {
        "user_id": "user_id",
        "user_type": "SERVICE_ACCOUNT",
        "key_value": "key_abc123",
        "created_at": "2024-01-01T00:00:00Z",
        "key_status": "ACTIVE",
        "expires_at": "2024-04-01T00:00:00Z",
        "overlap_expires_at": "2024-03-08T00:00:00Z",
        "last_rotated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "next_cursor": "cursor_value"
  }
}