Create team list

  • Updated on Sep 3, 2025
  • Published on Sep 2, 2025
Prev Next
Post
/team/list

Create a new team list

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Body parameters
object
list_slug
string Required

User-defined ID, used to reference list in queries. Restricted to characters A-Z, a-z, 0-9 and _.

list_name
string Required

List name, used in product UI.

list_type
string Required

List type.

Valid values[ "account_ids" ]
ds_id
string

Data source ID. If not provided or empty string, list is global and available for all data sources.

show_in_products

List of Supermetrics products this list should be shown in. If not provided or empty list, not shown in any product.

OneOf
string
string
Valid values[ "API", "DWH", "MND" ]
array
array
string
Valid values[ "API", "DWH", "MND" ]
Responses
201

Team list created successfully

Expand All
object
meta
object
request_id
string

API request ID

data
object (TeamList)
list_id
string

Supermetrics list ID

list_slug
string

User-defined ID, used to reference list in queries

list_name
string

List name

list_type
string

List type

Valid values[ "account_ids" ]
ds_id
string

Data source ID. Empty string when list is global.

ds_name
string

Data source name. Empty string when list is global.

show_in_products
Array of string

List of Supermetrics products this list should be shown in. If empty, not shown in any product.

string
Valid values[ "API", "DWH", "MND" ]
400

Team list slug contains invalid characters

object
error
string
Valid values[ "LIST_SLUG_INVALID" ]
message
string
409

Team list slug conflict

OneOf
ListSlugExistsError
object (ListSlugExistsError)
error
string

Team list slug already exists for specified data source ID

Valid values[ "LIST_SLUG_EXISTS" ]
message
string
ListSlugReservedError
object (ListSlugReservedError)
error
string

Team list slug is reserved for system use

Valid values[ "LIST_SLUG_RESERVED" ]
message
string
500

Failed to create team list

object
error
string
Valid values[ "LIST_CREATE_FAILED" ]
message
string