List All Quickstart Packages

Returns a list of all Quickstart packages within your Fivetran account or withing the specified group in your account.

Request schema

Query parameters

group_id

string

The unique identifier for the Group within the Fivetran system.

example:

group_id

cursor

string

Paging cursor, read more about pagination

example:

qq34ja5jhl51hl

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

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/qdm/packages

GET /v1/qdm/packages?group_id=group_id&cursor=qq34ja5jhl51hl&limit=100 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 return items

stringrequired

The unique identifier for the Quickstart Package within the Fivetran system.

example:

package_id

version

string

schedule

objectrequired

interval

integer

Interval.

format:

int32

example:

schedule_type

stringrequired

Schedule type

enum:

"INTEGRATED""TIME_OF_DAY""INTERVAL"

days_of_week

array

Days of week

example:

MONDAY,FRIDAY

type:

string

time_of_day

string

The time of the day the transformation should be launched at. The following values are supported: '00:00', '00:30', '01:00', '01:30', '02:00', '02:30', '03:00', '03:30', '04:00', '04:30', '05:00', '05:30', '06:00', '06:30', '07:00', '07:30', '08:00', '08:30', '09:00', '09:30', '10:00', '10:30', '11:00', '11:30', '12:00', '12:30', '13:00', '13:30', '14:00', '14:30', '15:00', '15:30', '16:00', '16:30', '17:00', '17:30', '18:00', '18:30', '19:00', '19:30', '20:00', '20:30', '21:00', '21:30', '22:00', '22:30', '23:00', '23:30'

example:

14:00

created_at

stringrequired

The timestamp when Quickstart Package was created.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

connection_ids

arrayrequired

The list of unique identifiers for the connections within the Fivetran system.

example:

connector_id

type:

string

group_id

stringrequired

The unique identifier for the Group within the Fivetran system.

example:

group_id

created_by_id

stringrequired

The unique identifier for the User within the Fivetran system.

example:

user_id

nextCursor

string

The value of the cursor parameter for the next page

example:

cursor_value

{
  "code": "Success",
  "message": "Operation performed.",
  "data": {
    "items": [
      {
        "id": "package_id",
        "version": "string",
        "schedule": {
          "interval": 60,
          "schedule_type": "TIME_OF_DAY",
          "days_of_week": [
            "MONDAY",
            "FRIDAY"
          ],
          "time_of_day": "14:00"
        },
        "created_at": "2023-08-20T10:15:20.677566Z",
        "connection_ids": [
          "connector_id"
        ],
        "group_id": "group_id",
        "created_by_id": "user_id"
      }
    ],
    "nextCursor": "cursor_value"
  }
}