Productivity Platform API and Features

https://docs.rize.io
Admin
This project provides comprehensive documentation for a productivity platform, covering its API and...
Tokens:115,133
Snippets:1,370
Trust Score:9.9
Update:5 days ago
Show doc for...
Tokens:
Raw
### get_help

Source: https://docs.rize.io/mcp/tools

Get documentation on how to use Rize MCP tools. Pass a topic to get specific help, or omit for an overview.

```APIDOC
## get_help

### Description
Get documentation on how to use Rize MCP tools. Pass a topic to get specific help, or omit for an overview. Topics: time_tracking, profitability, team_management, clients_projects, keywords, skills, reports_routines.

### Method
Read

### Parameters
#### Query Parameters
- **topic** (string) - Optional - One of `overview`, `time_tracking`, `profitability`, `team_management`, `clients_projects`, `keywords`, `skills`, `reports_routines`. Help topic. Default `"overview"`.

```

--------------------------------

### get_product_docs

Source: https://docs.rize.io/mcp/tools

Get documentation about the Rize product itself: what Rize can do, which integrations are supported, and where to find help articles. Use this to answer questions about Rize features, integrations, platforms, or setup.

```APIDOC
## get_product_docs

### Description
Get documentation about the Rize product itself: what Rize can do, which integrations are supported, and where to find help articles. Use this to answer questions about Rize features, integrations, platforms, or setup — never guess. Pass a `query` to search the documentation and get the matching sections back as the docs' own prose, each with a deep link — prefer this over the static topics when the question is about a specific feature, and quote the returned steps rather than paraphrasing them. Colloquial wording works: the search widens common phrasings ("clip", "overlay", "that bar") to the product's own vocabulary. Use topic "support" whenever the docs don't cover the question, the user hit a bug, or they want to request a feature — it returns where to reach a human instead of guessing. Topics: overview, integrations, docs_index, support.

### Method
Read

### Parameters
#### Query Parameters
- **topic** (string) - Optional - One of `overview`, `integrations`, `docs_index`, `support`. Documentation topic. Default `"overview"`.
- **query** (string) - Optional - Search the full documentation index by keyword. Takes precedence over topic.

```

--------------------------------

### Harvest Pagination Implementation

Source: https://docs.rize.io/migrations/harvest

Python example demonstrating how to follow the links.next URL for pagination when fetching time entries.

```python
url = "https://api.harvestapp.com/v2/time_entries"  
params = {"from": from_date, "to": to_date, "per_page": 1000}  
  
while url:  
    response = session.get(url, params=params, headers=headers)  
    respect_rate_limits(response)  
    data = response.json()  
    write_jsonl(data["time_entries"])  
  
    url = data["links"]["next"]  
    params = None  
```

--------------------------------

### Successful Response from GraphQL API

Source: https://docs.rize.io/graphql-api/graphql-auth

Example response returned by the GraphQL API for the current user query.

```json
{"data":{"currentUser":{"email":"youremail@domain.com"}}}  

```

--------------------------------

### CreateProject Mutation with cURL

Source: https://docs.rize.io/graphql-api/graphql-examples

Executes a CreateProject mutation to create a new project. Includes the request, a successful response, and an example error response.

```bash
curl -X POST https://api.rize.io/api/v1/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "query": "mutation CreateProject($name: String!) { createProject(input: { args: { name: $name } }) { project { id name } } }",
  "variables": {
    "name": "Your Project Name"
  }
}'
```

```json
{"data":{"createProject":{"project":{"id":"124112319","name":"Your Project Name"}}}}
```

```json
{"data":{"createProject":null},"errors":[{"message":"You must be signed in to access mutation CreateProject","locations":[{"line":1,"column":42}],"path":["createProject"],"extensions":{"code":"AUTHENTICATION_ERROR"}}]}
```

--------------------------------

### Authorization Header Example

Source: https://docs.rize.io/graphql-api/graphql-auth

Shows the required Authorization header format for GraphQL API requests. Use 'Bearer YOUR_API_KEY' as the value.

```json
{  
	"Authorization": "Bearer YOUR_API_KEY"  
}  

```

--------------------------------

### Project Query

Source: https://docs.rize.io/graphql-api/graphql-examples

Example GraphQL query to fetch a project by its ID. The query requires an ID variable and returns the project's id and name.

```APIDOC
## Project Query

### Description
Fetches a project by its ID using the Project query.

### Method
POST

### Endpoint
https://api.rize.io/api/v1/graphql

### Headers
- Content-Type: application/json
- Authorization: Bearer YOUR_API_KEY

### Request Body
- query (string) - Required - GraphQL query string: query Project($id: ID!) { project(id: $id) { id name } }
- variables (object) - Required - Contains the variable values.
  - id (ID!) - Required - The ID of the project to fetch.

### Request Example
{
  "query": "query Project($id: ID!) { project(id: $id) { id name } }",
  "variables": {
    "id": "124119"
  }
}

### Response
#### Success Response
- data.project.id (ID) - The project ID.
- data.project.name (String) - The project name.

#### Response Example
{"data":{"project":{"id":"124119","name":"Your Project Name"}}}

#### Error Response
- errors (array) - List of errors.
  - message (string) - Error message.
  - locations (array) - Error location in the query.
  - extensions (object) - Additional error details.

#### Error Example
{"errors":[{"message":"Variable $id of type ID! was provided invalid value","locations":[{"line":1,"column":15}],"extensions":{"value":null,"problems":[{"path":[],"explanation":"Expected value to not be null"}]}}]}
```

--------------------------------

### Fetch the First N Items with GraphQL Query and Variables

Source: https://docs.rize.io/graphql-api/graphql-pagination

This example demonstrates how to fetch the first two projects using the projects query, providing the initial variables and showing the expected JSON response structure.

```graphql
query Projects($first: Int, $after: String) {  
  projects(first: $first, after: $after) {  
    edges {  
      node {  
        id  
        name  
      }  
      cursor  
    }  
    pageInfo {  
      hasNextPage  
      hasPreviousPage  
      startCursor  
      endCursor  
    }  
  }  
}  
```

```json
{  
  "first": 2,  
  "after": null  
}
```

```json
{
  "data": {
    "projects": {
      "edges": [
        {
          "node": {
            "id": "1123124126",
            "name": "Project ABC"
          },
          "cursor": "MQ"
        },
        {
          "node": {
            "id": "12434423422125",
            "name": "Project XYZ1"
          },
          "cursor": "Mg"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false,
        "startCursor": "MQ",
        "endCursor": "Mg"
      }
    }
  }
}
```

--------------------------------

### get_current_user

Source: https://docs.rize.io/mcp/tools

Get the authenticated user's profile including name, email, timezone, default team, team memberships, and organization info. Call this first to get your org_id and team_id for other tools.

```APIDOC
## get_current_user

### Description
Get the authenticated user's profile including name, email, timezone, default team, team memberships (team id, name, role, status), and organization info (id, name, logo, role, finance permission). Call this first to get your org_id and team_id for other tools.

### Method
Read

### Parameters
Takes no parameters.

```

--------------------------------

### GET /v2/tasks

Source: https://docs.rize.io/migrations/harvest

Retrieves the task catalog from Harvest. The task catalog is account-global.

```APIDOC
## GET /v2/tasks

### Description
Retrieves the task catalog from Harvest. The task catalog is account-global.

### Method
GET

### Endpoint
/v2/tasks

### Response
#### Success Response (200)
- **tasks** (array) - List of task objects

#### Response Example
{
  "tasks": [
    {
      "id": 789,
      "name": "Example Task"
    }
  ]
}
```

--------------------------------

### get_tagging_settings

Source: https://docs.rize.io/mcp/tools

Gets the current user's auto-tagging settings. Read-only; use update_tagging_settings to change settings.

```APIDOC
## get_tagging_settings

### Description
Get the current user's auto-tagging settings: generation mode, entry duration preferences, auto-approve threshold, which tag dimensions are automated, custom instructions, and agent guidance.

### Method
Read

### Parameters
None

### Response
Returns the current tagging settings.
```

--------------------------------

### sign_up

Source: https://docs.rize.io/mcp/tools

Create a new Rize account via magic link. Sends a sign-in link to the user's email. After clicking the link, the user should download the Rize desktop app to start tracking time automatically.

```APIDOC
## sign_up

### Description
Create a new Rize account via magic link. Sends a sign-in link to the user's email. After clicking the link, the user should download the Rize desktop app to start tracking time automatically.

### Method
Write · no authentication required

### Parameters
#### Request Body
- **email** (string) - Required - User's email address.
- **name** (string) - Optional - User's full name.
- **timezone** (string) - Optional - IANA timezone (e.g. America/New_York). Defaults to UTC.

```

--------------------------------

### Fetch the Previous Page with GraphQL Query and Variables

Source: https://docs.rize.io/graphql-api/graphql-pagination

This example shows how to fetch the previous page of items using the last and before arguments, utilizing the startCursor from a previous response.

```graphql
query Projects($last: Int, $before: String) {  
  projects(last: $last, before: $before) {  
    edges {  
      node {  
        id  
        name  
      }  
      cursor  
    }  
    pageInfo {  
      hasNextPage  
      hasPreviousPage  
      startCursor  
      endCursor  
    }  
  }  
}  
```

```json
{
  "last": 2
  "before": "Mg"
}
```

--------------------------------

### Clients, projects, and tasks tools

Source: https://docs.rize.io/mcp/tools

Tools for managing clients, projects, and tasks.

```APIDOC
## Clients, projects, and tasks tools

### Tools
- `list_clients`
- `create_client`
- `update_client`
- `list_projects`
- `create_project`
- `update_project`
- `list_tasks`
- `create_task`
- `update_task`

```

--------------------------------

### GET /v2/clients

Source: https://docs.rize.io/migrations/harvest

Retrieves the list of clients from Harvest. Include archived and inactive records because historical entries can still reference them.

```APIDOC
## GET /v2/clients

### Description
Retrieves the list of clients from Harvest. Include archived and inactive records because historical entries can still reference them.

### Method
GET

### Endpoint
/v2/clients

### Response
#### Success Response (200)
- **clients** (array) - List of client objects

#### Response Example
{
  "clients": [
    {
      "id": 123,
      "name": "Example Client",
      "is_active": true
    }
  ]
}
```

--------------------------------

### get_report_run

Source: https://docs.rize.io/mcp/tools

Gets a single report run by ID, including the parent report metadata and all AI analyses with summaries and insights.

```APIDOC
## get_report_run

### Description
Get a single report run by ID, including the parent report metadata and all AI analyses with summaries and insights.

### Method
Read

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| id | string | yes | Report run ID. |
```

--------------------------------

### get_routine_run

Source: https://docs.rize.io/mcp/tools

Gets a single routine run by ID, including the parent routine metadata and all briefs the run produced with their markdown bodies.

```APIDOC
## get_routine_run

### Description
Get a single routine run by ID, including the parent routine metadata and all briefs the run produced with their markdown bodies.

### Method
Read

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| id | string | yes | Routine run ID. |
```

--------------------------------

### Session and discovery tools

Source: https://docs.rize.io/mcp/tools

Tools for user session, team listing, help, product docs, UI map, skills, login URL, and sign-up.

```APIDOC
## Session and discovery tools

### Tools
- `get_current_user`
- `list_teams`
- `get_help`
- `get_product_docs`
- `get_ui_map`
- `list_skills`
- `get_skill`
- `get_login_url`
- `sign_up`

```
Tokens:
Raw