List All Destinations within Account
Returns a list of all groups 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
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
application/json
example:
application/json
Http + 1.1
GET
https://api.fivetran.com/v1/groups
GET /v1/groups?cursor=cursor_value&limit=100 HTTP/1.1 Accept: application/json Authorization: BasicHost: api.fivetran.com
Responses
200
Successful response
200
code
stringrequired
Response status code
example:
Success
message
string
Response status text
example:
Groups retrieved successfully
data
undefinedrequired
items
arrayrequired
The collection of returned items
id
stringrequired
The unique identifier for the group within the Fivetran system.
example:
group_id
name
stringrequired
The name of the group within your account.
example:
Group_Name
created_at
stringrequired
The timestamp of when the group was created in your 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": "Groups retrieved successfully", "data": { "items": [ { "id": "group_id", "name": "Group_Name", "created_at": "2024-01-01T00:00:00Z" } ], "next_cursor": "cursor_value" } }