Chartio Admin API documentation version v1

https://api.chartio.com/{version}/

The Chartio Admin API provides programmatic access to select resources within a Chartio organization.

API credentials are managed within the Chartio UI, from the Admin API tab under the settings menu (contact Chartio support if you need access enabled). All endpoints are secured using HTTP Basic Authentication.

The API utilizes the Hypertext Application Language standard to provide links between related API resources, such as paginated collections and nested objects. More information on HAL can be found here: http://stateless.co/hal_specification.html.

version: required(v1)

/{orgSlug}

/{orgSlug} get

get

The root of the Chartio Admin API for this org.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

HTTP status code 200

Links to resources within this org which can be managed by the currently authenticated service account.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
chartio:teams: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
chartio:users: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams get post

Provides a listing of all teams within an org, as well as the ability to create new teams.

get

The collection of teams belonging to this org.

Teams responses are paginated with a default of 100 teams per page. See the _links metadata at the top level of the response for pagination links.

post

Create a new team.

The collection of teams belonging to this org.

Teams responses are paginated with a default of 100 teams per page. See the _links metadata at the top level of the response for pagination links.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

HTTP status code 200

Returns a paginated list of teams. Each team's users are listed as nested resources within each team.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
A collection of links to related resources.
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
- next: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- previous: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
Example:
```
{
  "self": {
    "href": "/example-org/items/?page=2"
  },
  "next": {
    "href": "/example-org/items/?page=3"
  },
  "previous": {
    "href": "/example-org/items/?page=1"
  }
}
```
_embedded: (object)
count: required(integer)
teams: required(array of TeamResponse)
Items: TeamResponse
- _links: required(object)
  - self: required(object)
    A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
    - href: required(string)
  - curies: (array of HalCurie)
    Items: HalCurie
    href: required(string)
    name: (string)
    templated: (boolean)
  Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
```
{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}
```

Example:

{
  "count": 200,
  "teams": [
    {
      "id": 4,
      "name": "Sales",
      "is_owner": false,
      "created_at": "2018-10-04T00:00:00Z",
      "updated_at": "2018-10-04T01:11:11Z",
      "_links": {
        "self": {
          "href": "/example-org/teams/4/"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/example-org/teams/"
    },
    "next": {
      "href": "/example-org/teams/?page=2"
    }
  }
}

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Create a new team.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

Body

Media type: application/json

Type: object

Properties

name: required(string)
id: (integer)

Example:

{
  "name": "Sales"
}

HTTP status code 201

Headers

Location: required(string)
URL pointing to newly created team.
Example:
```
/example-org/teams/1/
```

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

HTTP status code 403

Orgs are limited to 2,000 teams.

HTTP status code 409

A team with the same name already exists.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/{teamId} get delete patch

Provides methods for getting, modifying, and deleting a team.

Within the team resources, there are two teams with special properties:

The Owners team. The Owners Team is included by default, and has global admin permissions for all account settings. The Owners team cannot be deleted or renamed and must always have at least one member. The {orgSlug}/teams/owners endpoint is provided as a convenience to access the Owners team.
The "Added from Dashboard" team. This team is created when the first user is added to the organization via dashboard sharing. It includes all users which were initially added to the organization through sharing. This team cannot be deleted or renamed. Users cannot be added to it via the API, but can be removed.

get

Retrieves a team with all of its member users.

delete

Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.

patch

Rename a team. The Owners team cannot be renamed.

Retrieves a team with all of its member users.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
teamId: required(integer)
The team identifier.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Rename a team. The Owners team cannot be renamed.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
teamId: required(integer)
The team identifier.

Body

Media type: application/json

Type: object

Properties

id: (integer)
name: (string)

Example:

{
  "name": "Updated Team Name"
}

HTTP status code 200

The team was successfully renamed.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

HTTP status code 405

Attempted to modify the Owners or "Added from Dashboard" teams, which cannot be modified.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/{teamId}/users patch

Write-only collection of users who are members of this team.

patch

Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
teamId: required(integer)
The team identifier.

Body

Media type: application/json

Type: object

Properties

id: (integer)
An unique user identifier generated by Chartio when a user was created.
email: (string)
The user's email address. This is not guaranteed to be a consistent identifier as users can change their email address.

Examples:

id:

{
  "id": 2
}

email:

{
  "email": "marketing-user@example.com"
}

HTTP status code 200

User was added to this team.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

HTTP status code 403

Orgs are limited to 10,000 users.

HTTP status code 405

Attempted to add a user to the "Added from Dashboard" team, which can only be modified by sharing a dashboard with a non-user from within the app.

HTTP status code 409

User is already a member of this team.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/{teamId}/users/{userId} delete

Delete-only resource for an individual member of this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.

delete

Remove a user from this team.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
teamId: required(integer)
The team identifier.
userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
```
1
```
email:
```
user@example.com
```

HTTP status code 204

User was removed from this team.

HTTP status code 400

Users must belong to at least one team. Deleting the user from their only team is not allowed; delete the user instead. In addition, this response will also be returned when attempting to remove the last user from the owners team, which must always have at least one member.

HTTP status code 404

User was not a member of this team.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/owners get delete patch

A resource for the Owners team, which has admin capabilities within Chartio. The Owners team cannot be renamed or deleted.

get

Retrieves a team with all of its member users.

delete

Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.

patch

Rename a team. The Owners team cannot be renamed.

Retrieves a team with all of its member users.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Rename a team. The Owners team cannot be renamed.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

Body

Media type: application/json

Type: object

Properties

id: (integer)
name: (string)

Example:

{
  "name": "Updated Team Name"
}

HTTP status code 200

The team was successfully renamed.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

HTTP status code 405

Attempted to modify the Owners or "Added from Dashboard" teams, which cannot be modified.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/owners/users patch

Write-only collection of users who are members of this team.

patch

Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

Body

Media type: application/json

Type: object

Properties

id: (integer)
An unique user identifier generated by Chartio when a user was created.
email: (string)
The user's email address. This is not guaranteed to be a consistent identifier as users can change their email address.

Examples:

id:

{
  "id": 2
}

email:

{
  "email": "marketing-user@example.com"
}

HTTP status code 200

User was added to this team.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
name: required(string)
is_owner: required(boolean)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 3,
  "name": "Marketing",
  "is_owner": false,
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T01:11:11Z",
  "_links": {
    "self": {
      "href": "/example-org/teams/3/"
    }
  },
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "/example-org/users/2/"
          }
        },
        "id": 2,
        "email": "marketing-user@example.com",
        "display_name": "Marketing User"
      }
    ]
  }
}

HTTP status code 403

Orgs are limited to 10,000 users.

HTTP status code 405

Attempted to add a user to the "Added from Dashboard" team, which can only be modified by sharing a dashboard with a non-user from within the app.

HTTP status code 409

User is already a member of this team.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/teams/owners/users/{userId} delete

delete

Remove a user from this team.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
```
1
```
email:
```
user@example.com
```

HTTP status code 204

User was removed from this team.

HTTP status code 400

HTTP status code 404

User was not a member of this team.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/users get post

get

The collection of users belonging to this org.

Users responses are paginated with a default of 100 teams per page. See the _links metadata at the top level of the response for pagination links.

post

Adds a new user to this org and add them to a team. Users must initially belong to a team when created.

The collection of users belonging to this org.

Users responses are paginated with a default of 100 teams per page. See the _links metadata at the top level of the response for pagination links.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
A collection of links to related resources.
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
- next: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- previous: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
Example:
```
{
  "self": {
    "href": "/example-org/items/?page=2"
  },
  "next": {
    "href": "/example-org/items/?page=3"
  },
  "previous": {
    "href": "/example-org/items/?page=1"
  }
}
```
_embedded: (object)
count: required(integer)
users: required(array of UserResponse)
Items: UserResponse
- _links: required(object)
  - self: required(object)
    A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
    - href: required(string)
  - curies: (array of HalCurie)
    Items: HalCurie
    href: required(string)
    name: (string)
    templated: (boolean)
  Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
- _embedded: (object)
- id: required(integer)
- email: required(string)
- display_name: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
```
{
  "id": 2,
  "email": "user@example.com",
  "display_name": "Example User",
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T00:00:00Z",
  "_links": {
    "self": {
      "href": "/example-org/users/2/"
    }
  },
  "_embedded": {
    "teams": [
      {
        "_links": {
          "self": {
            "href": "/example-org/teams/1/"
          }
        },
        "id": 1,
        "name": "Owners"
      }
    ]
  }
}
```

Example:

{
  "count": 200,
  "_links": {
    "self": {
      "href": "/example-org/users/"
    },
    "next": {
      "href": "/example-org/users/?page=2"
    }
  },
  "users": [
    {
      "id": 2,
      "email": "user@example.com",
      "display_name": "Example User",
      "created_at": "2018-10-04T00:00:00Z",
      "updated_at": "2018-10-04T00:00:00Z",
      "_links": {
        "self": {
          "href": "/example-org/users/2/"
        }
      },
      "_embedded": {
        "teams": [
          {
            "_links": {
              "self": {
                "href": "/example-org/teams/1/"
              }
            },
            "id": 1,
            "name": "Owners"
          }
        ]
      }
    }
  ]
}

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Adds a new user to this org and add them to a team. Users must initially belong to a team when created.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

Body

Media type: application/json

Type: object

Properties

email: required(string)
team: required(object)
- id: required(integer)
  Id of existing resource to be linked.
Example:
```
{
  "id": 1
}
```

Example:

{
  "email": "new-user@example.com",
  "team": {
    "id": 1
  }
}

HTTP status code 201

Headers

Location: required(string)
URL pointing to newly created user.
Example:
```
/example-org/users/1/
```

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
email: required(string)
display_name: required(string)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 2,
  "email": "user@example.com",
  "display_name": "Example User",
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T00:00:00Z",
  "_links": {
    "self": {
      "href": "/example-org/users/2/"
    }
  },
  "_embedded": {
    "teams": [
      {
        "_links": {
          "self": {
            "href": "/example-org/teams/1/"
          }
        },
        "id": 1,
        "name": "Owners"
      }
    ]
  }
}

HTTP status code 400

An existing team must be provided.

HTTP status code 403

Orgs are limited to 10,000 users.

HTTP status code 409

User with matching email already exists in the org and on the specified team.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/users/{userId} delete get

Provides the capability to read, and delete individual users. {userId} can refer to either a Chartio user id (preferred), or an email address. Users' email addresses may change, so emails are not guaranteed to be consistent identifiers. Note that individual user data is read-only once created. Users can change their email address and display name within the app.

delete

Removes a user from all teams of a given organization. This does not delete a user from other organizations. Users that are the last member of the owners team cannot be removed from that organization.

get

Gets a user.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
```
1
```
email:
```
user@example.com
```

HTTP status code 204

User was deleted.

HTTP status code 400

User was last member of the owners team.

HTTP status code 404

User was not found.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Gets a user.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
```
1
```
email:
```
user@example.com
```

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
email: required(string)
display_name: required(string)
created_at: required(datetime)
updated_at: required(datetime)

Example:

{
  "id": 2,
  "email": "user@example.com",
  "display_name": "Example User",
  "created_at": "2018-10-04T00:00:00Z",
  "updated_at": "2018-10-04T00:00:00Z",
  "_links": {
    "self": {
      "href": "/example-org/users/2/"
    }
  },
  "_embedded": {
    "teams": [
      {
        "_links": {
          "self": {
            "href": "/example-org/teams/1/"
          }
        },
        "id": 1,
        "name": "Owners"
      }
    ]
  }
}

HTTP status code 404

User was not found.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/datasources get

get

The collection of datasources belonging to this org.

Datasource responses are paginated with a default of 100 datasources per page. See the _links metadata at the top level of the response for pagination links.

The collection of datasources belonging to this org.

Datasource responses are paginated with a default of 100 datasources per page. See the _links metadata at the top level of the response for pagination links.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
A collection of links to related resources.
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
- next: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- previous: (object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
Example:
```
{
  "self": {
    "href": "/example-org/items/?page=2"
  },
  "next": {
    "href": "/example-org/items/?page=3"
  },
  "previous": {
    "href": "/example-org/items/?page=1"
  }
}
```
_embedded: (object)
count: required(integer)
users: required(array of DataSourceResponse)
Items: DataSourceResponse
- _links: required(object)
  - self: required(object)
    A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
    - href: required(string)
  - curies: (array of HalCurie)
    Items: HalCurie
    href: required(string)
    name: (string)
    templated: (boolean)
  Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
- _embedded: (object)
- id: required(integer)
- alias: required(string)
- slug: required(string)
- dstype: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
- last_reflected: required(datetime)
- last_refreshed_at: required(datetime)
Example:
```
{
  "id": 3,
  "alias": "Data Warehouse",
  "slug": "data-warehouse",
  "created_at": "2019-03-04T00:00:00Z",
  "updated_at": "2019-03-12T00:00:00Z",
  "last_reflected": "2019-03-12T00:00:00Z",
  "last_refreshed_at": null,
  "_links": {
    "self": {
      "href": "/example-org/datasources/3/"
    }
  }
}
```

Example:

{
  "count": 1,
  "_links": {
    "self": {
      "href": "/example-org/datasources/"
    },
    "next": {
      "href": "/example-org/datasources/?page=2"
    }
  },
  "datasources": [
    {
      "id": 3,
      "alias": "Data Warehouse",
      "slug": "data-warehouse",
      "created_at": "2019-03-04T00:00:00Z",
      "updated_at": "2019-03-12T00:00:00Z",
      "last_reflected": "2019-03-12T00:00:00Z",
      "last_refreshed_at": null,
      "_links": {
        "self": {
          "href": "/example-org/datasources/3/"
        }
      }
    }
  ]
}

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

/{orgSlug}/datasources/{datasourceId} get patch

get

Gets a datasource

patch

Update the attributes of a Chartio datasource.

Gets a datasource

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
datasourceId: required(integer)
The datasource identifier.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
alias: required(string)
slug: required(string)
dstype: required(string)
created_at: required(datetime)
updated_at: required(datetime)
last_reflected: required(datetime)
last_refreshed_at: required(datetime)

Example:

{
  "id": 3,
  "alias": "Data Warehouse",
  "slug": "data-warehouse",
  "created_at": "2019-03-04T00:00:00Z",
  "updated_at": "2019-03-12T00:00:00Z",
  "last_reflected": "2019-03-12T00:00:00Z",
  "last_refreshed_at": null,
  "_links": {
    "self": {
      "href": "/example-org/datasources/3/"
    }
  }
}

HTTP status code 404

DataSource was not found.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Update the attributes of a Chartio datasource.

Secured by basicAuth

Each request must contain the headers necessary for basic authentication.

URI Parameters

orgSlug: required(string)
The Chartio organization slug.
datasourceId: required(integer)
The datasource identifier.

Body

Media type: application/json

Type: object

Properties

alias: (string)
The title of the datasource as displayed in the Chartio UI.
last_refreshed_at: (datetime)
The datasource's last_refreshed_at time.
last_refreshed_at time must be specified using in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]) and must resolve to being within 10 minutes of the current time on the Chartio servers.
Data stored in the Chartio cache that was fetched prior to the last_refreshed_at time on a datasource will be considered invalid.

Example:

{
  "alias": "Data Warehouse (Redshift)",
  "last_refreshed_at": "2019-04-01T00:00:00Z"
}

HTTP status code 200

The datasource's last_refreshed_at time was updated.

Body

Media type: application/json

Type: object

Properties

_links: required(object)
- self: required(object)
  A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
  - href: required(string)
- curies: (array of HalCurie)
  Items: HalCurie
  - href: required(string)
  - name: (string)
  - templated: (boolean)
Example:
```
{
  "self": {
    "href": "/example-org/items/"
  }
}
```
_embedded: (object)
id: required(integer)
alias: required(string)
slug: required(string)
dstype: required(string)
created_at: required(datetime)
updated_at: required(datetime)
last_reflected: required(datetime)
last_refreshed_at: required(datetime)

Example:

{
  "id": 3,
  "alias": "Data Warehouse",
  "slug": "data-warehouse",
  "created_at": "2019-03-04T00:00:00Z",
  "updated_at": "2019-03-12T00:00:00Z",
  "last_reflected": "2019-03-12T00:00:00Z",
  "last_refreshed_at": null,
  "_links": {
    "self": {
      "href": "/example-org/datasources/3/"
    }
  }
}

HTTP status code 400

Attempted to set a property to an invalid value.

Secured by basicAuth

Headers

Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.

HTTP status code 401

Unauthorized. The provided api_key and secret combination is invalid.

HTTP status code 403

Forbidden. The api_key is not allowed to access the content provided by the requested URL.

Chartio Admin API documentation version v1

/{orgSlug}

get /{orgSlug}

URI Parameters

HTTP status code 200

Body

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

get /{orgSlug}/teams

URI Parameters

HTTP status code 200

Body

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

post /{orgSlug}/teams

URI Parameters

Body

HTTP status code 201

Headers

Body

HTTP status code 403

HTTP status code 409

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

get /{orgSlug}/teams/{teamId}

URI Parameters

HTTP status code 200

Body

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

delete /{orgSlug}/teams/{teamId}

URI Parameters

HTTP status code 204

HTTP status code 404

HTTP status code 405

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

patch /{orgSlug}/teams/{teamId}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 405

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

patch /{orgSlug}/teams/{teamId}/users

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 403

HTTP status code 405

HTTP status code 409

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

delete /{orgSlug}/teams/{teamId}/users/{userId}

URI Parameters

HTTP status code 204

HTTP status code 400

HTTP status code 404

Secured by basicAuth

Headers

HTTP status code 401

HTTP status code 403

get /{orgSlug}/teams/owners

URI Parameters