Get transfer options

Updated on Oct 22, 2026
Published on Jul 1, 2026

Get

/v1/teams/{team_id}/transfers/available-options

Returns all available options for a Hub transfer, according to specific data source and destination.

Returns: Transfer configuration parameters for the given source/destination combination.

Important Notes:

You must have dwh.transfer.view permission

Rate limited: calls to this endpoint within 200ms of the team's previous call return 429. Every call that passes authentication and access checks and isn't itself rate-limited starts the window, even if it then fails (e.g. 404). The window is shared by all API keys and access tokens of the team, and does not depend on resource IDs in the path.

Security

HTTP

Type bearer

API key authentication. Create API keys in the Supermetrics Hub and send them in the Authorization header: Authorization: Bearer <your-api-key>

Path parameters

team_id

integer (int64) Required

ID of the team

Minimum1

Maximum9223372036854776000

Example936506

Query parameters

source_id

stringRequired

Data source identifier

Max length50

ExampleADM

destination_id

integer (int32) Required

Destination identifier

Example8

Responses

200

Transfer options retrieved successfully

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

Expand All

object

Transfer configuration options for a given source/destination combination

data_source

object

Data source information and settings

data_source_id

string

Data source identifier

ExampleAW

service_name

string

Human-readable service name

ExampleGoogle Ads

settings

Array of object

Data source specific settings

object

schedule_options

Array of object

Available schedule options

object

schemas

Array of object

Available schemas for the transfer

object

logins

Array of object

Available logins for the data source

object

accounts

Array of object

Available accounts for the data source

object

segments

Array of object

Available segments for the data source

object

license

object

License information for the team

401

Unauthorized

Headers

WWW-Authenticate

string

Bearer token required

Max length255

Pattern^Bearer.*

X-RateLimit-Limit

integer (int32)

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer (int32)

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

403

Access forbidden

Headers

X-RateLimit-Limit

integer (int32)

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer (int32)

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to this resource."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

429

Too Many Requests

Headers

X-RateLimit-Limit

integer (int32)

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer (int32)

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Retry-After

integer (int32)

Seconds until rate limit resets

Minimum1

Maximum86400

Example3600

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Rate limit exceeded. Retry later."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

500

Internal server error

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

Was this article helpful?