Get User

curl --location --request GET 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

GET

api

user

curl --location --request GET 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Body

string

This is the name of the user group.

string

This is the ID you use to identify this user group in your database.

object

This is a JSON mapping of schema id to either the data source that this user group should be associated with or id of the datasource you provided when creating it.

object

This is a JSON object for properties assigned to this user group. These will be accessible through variables in the dashboards and SQL editor

Response

number

Indicates whether the call was successful. 1 if successful, 0 if not.

boolean

Indicates whether a new user group was created.

object

The contents of the user group

Show Toggle object

number

This is the internal ID for this user group. You don’t need to record this information, since you will not need to use it.

string

This is the user group token (userGroupToken or USER_GROUP_TOKEN) that will be used to identify which user group is viewing the dashboard. You should save this on your end to use when rendering an embedded dashboard.

string

This is the name of the user group provided in the request body.

string

This is the user_group_id provided in the request body.

JSON or null

This is the properties object if it was provided in the request body

curl --location --request GET 'https://api.mintlify.com/api/user' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "new_user_group": true,
  "user_group": {
    "team_id": 3,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1"
  }
}

Authentication Create User

API Documentation

Endpoint Examples

Body

Response

​Body

​Response

Body

Response