Motion

https://docs.usemotion.com
Admin
Motion is a project management and task automation platform that helps teams organize projects,...
Tokens:26,475
Snippets:97
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /v1/projects/{id}

Source: https://docs.usemotion.com/api-reference/projects/get

Retrieves a single project by its ID. Requires an API key in the X-API-Key header.

```APIDOC
## GET /v1/projects/{id}

### Description
Get a single project, given an ID.

### Method
GET

### Endpoint
`/v1/projects/{id}`

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the project to return.

### Response
#### Success Response (200)
- **id** (string) - Required - The ID of the project.
- **name** (string) - Required - The name of the project.
- **description** (string) - Required - The HTML contents of the description.
- **workspaceId** (string) - Required - The ID of the workspace.
- **status** (object) - The status of the project.
  - **name** (string) - The name of the status.
  - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
  - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.
- **createdTime** (datetime) - The timestamp when the project was created.
- **updatedTime** (datetime) - The timestamp when the project was last updated.
- **customFieldValues** (record<object>) - Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
  - **text** (object) - Text custom field value.
    - **type** (string) - Required - Always "text" for this field type.
    - **value** (string | null) - Text value or null.
  - **number** (object) - Number custom field value.
    - **type** (string) - Required - Always "number" for this field type.
    - **value** (number | null) - Numeric value or null.
  - **url** (object) - URL custom field value.
    - **type** (string) - Required - Always "url" for this field type.
    - **value** (string | null) - URL string or null.
  - **date** (object) - Date custom field value.
    - **type** (string) - Required - Always "date" for this field type.
    - **value** (string | null) - ISO date string or null.
  - **select** (object) - Select custom field value.
    - **type** (string) - Required - Always "select" for this field type.
    - **value** (string | null) - Selected option value or null.
  - **multiSelect** (object) - Multi-select custom field value.
    - **type** (string) - Required - Always "multiSelect" for this field type.
    - **value** (array<string> | null) - Array of selected option values or null.
  - **person** (object) - Person custom field value.
    - **type** (string) - Required - Always "person" for this field type.
    - **value** (object | null) - Person object or null.
      - **id** (string) - Required - User ID of the person.
      - **name** (string) - Required - Name of the person.
      - **email** (string) - Required - Email of the person.
  - **multiPerson** (object) - Multi-person custom field value.
    - **type** (string) - Required - Always "multiPerson" for this field type.
    - **value** (array<object> | null) - Array of person objects or null.
      - **[index]** (object) - Person object.
        - **id** (string) - Required - User ID of the person.
        - **name** (string) - Required - Name of the person.
        - **email** (string) - Required - Email of the person.
  - **email** (object) - Email custom field value.
    - **type** (string) - Required - Always "email" for this field type.
    - **value** (string | null) - Email address or null.
  - **phone** (object) - Phone custom field value.
    - **type** (string) - Required - Always "phone" for this field type.
    - **value** (string | null) - Phone number or null.
  - **checkbox** (object) - Checkbox custom field value.
    - **type** (string) - Required - Always "checkbox" for this field type.
    - **value** (boolean | null) - Boolean value or null.
  - **relatedTo** (object) - Related task custom field value.
    - **type** (string) - Required - Always "relatedTo" for this field type.
    - **value** (string | null) - Related task ID or null.

```

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

### GET /v1/schedules

Source: https://docs.usemotion.com/api-reference/schedules/get

Retrieves a list of schedules for the authenticated user. Requires an API key in the X-API-Key header.

```APIDOC
## GET /v1/schedules

### Description
Get a list of schedules for your user.

### Method
GET

### Endpoint
/v1/schedules

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **name** (string) - Required - The name of the schedule.
- **isDefaultTimezone** (boolean) - Required - Whether the schedule is the default timezone.
- **timezone** (string) - Required - The timezone of the schedule.
- **schedule** (object) - Required - The schedule details.
  - **monday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **tuesday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **wednesday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **thursday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **friday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **saturday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.
  - **sunday** (array<object>) - An array of objects detailing start and end times.
    - **start** (string) - When the schedule starts, formatted HH:MM.
    - **end** (string) - When the schedule ends, formatted HH:MM.

#### Response Example
```json
[
  {
    "name": "string",
    "isDefaultTimezone": true,
    "timezone": "string",
    "schedule": {
      "monday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "tuesday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "wednesday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "thursday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "friday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "saturday": [
        {
          "start": "string",
          "end": "string"
        }
      ],
      "sunday": [
        {
          "start": "string",
          "end": "string"
        }
      ]
    }
  }
]
```
```

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

### GET /v1/tasks

Source: https://docs.usemotion.com/api-reference/tasks/list

Retrieves all tasks matching the provided query parameters. Requires an API key for authentication.

```APIDOC
## GET /v1/tasks

### Description
Get all tasks for a given query.

### Method
GET

### Endpoint
/v1/tasks

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Parameters
#### Query Parameters
- **assigneeId** (string) - Optional - Limit tasks returned to a specific assignee.
- **cursor** (string) - Optional - Use if a previous request returned a cursor. Will page through results.
- **includeAllStatuses** (boolean) - Optional - Limit tasks returned by statuses that exist on tasks, cannot specify this ('includeAllStatuses') AND status in the same request.
- **label** (string) - Optional - Limit tasks returned by label on the task.
- **name** (string) - Optional - Limit tasks returned to those that contain this string. Case in-sensitive.
- **projectId** (string) - Optional - Limit tasks returned to a given project.
- **status** (array<string>) - Optional - Limit tasks returned by statuses that exist on tasks, cannot specify this ('status') AND includeAllStatuses in the same request.
- **workspaceId** (string) - Optional - The id of the workspace you want tasks from. If not provided, will return tasks from all workspaces the user is a member of.

### Response
#### Success Response (200)
- **meta** (object) - Required - Contains the nextCursor, if one exists, along with the pageSize.
  - **nextCursor** (string) - Make the same query with the new cursor to get more results.
  - **pageSize** (number) - The number of results in this response.
- **tasks** (array<object>) - Required - The tasks returned.
  - **id** (string) - Required - The ID of the task.
  - **name** (string) - Required - The name of the task.
  - **description** (string) - Required - The HTML contents of the description.
  - **duration** (string | number) - An integer greater than 0 (representing minutes), "NONE", or "REMINDER".
  - **dueDate** (datetime) - When is the task due.
  - **deadlineType** (string) - Required - Values are HARD, SOFT (default) or NONE.
  - **parentRecurringTaskId** (string) - Required - If this is an instance of a recurring task, this field will be the parent recurring task id.
  - **completed** (boolean) - Required - Whether the task is completed or not.
  - **completedTime** (datetime) - The timestamp when the task was completed.
  - **updatedTime** (datetime) - The timestamp when the task was last updated.
  - **startOn** (string) - Date indicating when a task should start, in YYYY-MM-DD format.
  - **creator** (object) - Required - The user who created the task.
    - **id** (string) - The user id of the creator.
    - **name** (string) - The name of the creator.
    - **email** (string) - The email of the creator.
  - **project** (object) - The project data.
    - **id** (string) - Required - The ID of the project.
    - **name** (string) - Required - The name of the project.
    - **description** (string) - Required - The HTML contents of the description.
    - **workspaceId** (string) - Required - The ID of the workspace.
    - **status** (object) - The status of the project.
      - **name** (string) - The name of the status.
      - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
      - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.
    - **createdTime** (datetime) - The timestamp when the project was created.
    - **updatedTime** (datetime) - The timestamp when the project was last updated.
    - **customFieldValues** (record<object>) - Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
      - **text** (object) - Text custom field value.
        - **type** (string) - Required - Always "text" for this field type.
        - **value** (string | null) - Text value or null.
      - **number** (object) - Number custom field value.
        - **type** (string) - Required - Always "number" for this field type.
        - **value** (number | null) - Numeric value or null.
      - **url** (object) - URL custom field value.
        - **type** (string) - Required - Always "url" for this field type.
        - **value** (string | null) - URL string or null.
      - **date** (object) - Date custom field value.
        - **type** (string) - Required - Always "date" for this field type.
        - **value** (string | null) - ISO date string or null.
      - **select** (object) - Select custom field value.
        - **type** (string) - Required - Always "select" for this field type.
        - **value** (string | null) - Selected option value or null.
      - **multiSelect** (object) - Multi-select custom field value.
        - **type** (string) - Required - Always "multiSelect" for this field type.
        - **value** (array<string> | null) - Array of selected option values or null.
      - **person** (object) - Person custom field value.
        - **type** (string) - Required - Always "person" for this field type.
        - **value** (string | null) - Person ID or null.

#### Response Example
```json
{
  "meta": {
    "nextCursor": "string",
    "pageSize": 0
  },
  "tasks": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "duration": "string",
      "dueDate": "2023-01-01T00:00:00Z",
      "deadlineType": "HARD",
      "parentRecurringTaskId": "string",
      "completed": false,
      "completedTime": "2023-01-01T00:00:00Z",
      "updatedTime": "2023-01-01T00:00:00Z",
      "startOn": "2023-01-01",
      "creator": {
        "id": "string",
        "name": "string",
        "email": "string"
      },
      "project": {
        "id": "string",
        "name": "string",
        "description": "string",
        "workspaceId": "string",
        "status": {
          "name": "string",
          "isDefaultStatus": false,
          "isResolvedStatus": false
        },
        "createdTime": "2023-01-01T00:00:00Z",
        "updatedTime": "2023-01-01T00:00:00Z",
        "customFieldValues": {
          "text": {
            "type": "text",
            "value": "string"
          },
          "number": {
            "type": "number",
            "value": 0
          },
          "url": {
            "type": "url",
            "value": "string"
          },
          "date": {
            "type": "date",
            "value": "2023-01-01"
          },
          "select": {
            "type": "select",
            "value": "string"
          },
          "multiSelect": {
            "type": "multiSelect",
            "value": ["string"]
          },
          "person": {
            "type": "person",
            "value": "string"
          }
        }
      }
    }
  ]
}
```
```

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

### GET /v1/projects

Source: https://docs.usemotion.com/api-reference/projects/list

Retrieves all projects for a workspace. Requires an X-API-Key header and a workspaceId query parameter. Supports pagination via a cursor.

```APIDOC
## [GET] /v1/projects

### Description
Get all projects for a workspace.

### Method
GET

### Endpoint
/v1/projects

### Authorization
- **X-API-Key** (string) - Required - API key in the header.

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Use if a previous request returned a cursor. Will page through results.
- **workspaceId** (string) - Required - The workspace for which all projects should be returned.

### Response
#### Success Response (200)
- **meta** (object) - required - Contains nextCursor and pageSize.
  - **nextCursor** (string) - The cursor to use for the next page of results.
  - **pageSize** (number) - The number of results in this response.
- **projects** (array<object>) - The projects returned.
  - **id** (string) - required - The ID of the project.
  - **name** (string) - required - The name of the project.
  - **description** (string) - required - The HTML contents of the description.
  - **workspaceId** (string) - required - The ID of the workspace.
  - **status** (object) - The status of the project.
    - **name** (string) - The name of the status.
    - **isDefaultStatus** (boolean) - Whether this is a default status.
    - **isResolvedStatus** (boolean) - Whether this is a resolved status.
  - **createdTime** (datetime) - When the project was created.
  - **updatedTime** (datetime) - When the project was last updated.
  - **customFieldValues** (record<object>) - Record of custom field values, keyed by custom field name.
    - **text** (object) - Text custom field value.
      - **type** (string) - required - Always "text".
      - **value** (string | null) - Text value or null.
    - **number** (object) - Number custom field value.
      - **type** (string) - required - Always "number".
      - **value** (number | null) - Numeric value or null.
    - **url** (object) - URL custom field value.
      - **type** (string) - required - Always "url".
      - **value** (string | null) - URL string or null.
    - **date** (object) - Date custom field value.
      - **type** (string) - required - Always "date".
      - **value** (string | null) - ISO date string or null.
    - **select** (object) - Select custom field value.
      - **type** (string) - required - Always "select".
      - **value** (string | null) - Selected option value or null.
    - **multiSelect** (object) - Multi-select custom field value.
      - **type** (string) - required - Always "multiSelect".
      - **value** (array<string> | null) - Array of selected option values or null.
    - **person** (object) - Person custom field value.
      - **type** (string) - required - Always "person".
      - **value** (object | null) - Person object or null.
        - **id** (string) - required - User ID.
        - **name** (string) - required - Name of the person.
        - **email** (string) - required - Email of the person.
    - **multiPerson** (object) - Multi-person custom field value.
      - **type** (string) - required - Always "multiPerson".
      - **value** (array<object> | null) - Array of person objects or null.
        - **[index]** (object) - Person object.
          - **id** (string) - required - User ID.
          - **name** (string) - required - Name of the person.
          - **email** (string) - required - Email of the person.
    - **email** (object) - Email custom field value.
      - **type** (string) - required - Always "email".
      - **value** (string | null) - Email address or null.
    - **phone** (object) - Phone custom field value.
      - **type** (string) - required - Always "phone".
      - **value** (string | null) - Phone number or null.
    - **checkbox** (object) - Checkbox custom field value.
      - **type** (string) - required - Always "checkbox".
      - **value** (boolean | null) - Boolean value or null.
    - **relatedTo** (object) - Related task custom field value.
      - **type** (string) - required - Always "relatedTo".
      - **value** (string | null) - Related task ID or null.

### Example Response
```json
{
  "meta": {
    "nextCursor": "string",
    "pageSize": 0
  },
  "projects": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "workspaceId": "string",
      "status": {
        "name": "string",
        "isDefaultStatus": true,
        "isResolvedStatus": false
      },
      "createdTime": "2023-01-01T00:00:00Z",
      "updatedTime": "2023-01-01T00:00:00Z",
      "customFieldValues": {}
    }
  ]
}
```
```

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

### GET /v1/recurring-tasks

Source: https://docs.usemotion.com/api-reference/recurring-tasks/get

Get all recurring tasks for a workspace. Requires an API key and a workspace ID.

```APIDOC
## GET /v1/recurring-tasks

### Description
Get all recurring tasks for a workspace.

### Method
GET

### Endpoint
/v1/recurring-tasks

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Use if a previous request returned a cursor. Will page through results.
- **workspaceId** (string) - Required - The workspace for which all recurring tasks should be returned.

### Response
#### Success Response (200)
- **meta** (object) - Required - Contains the nextCursor, if one exists, along with the pageSize.
  - **nextCursor** (string) - Make the same query with the new cursor to get more results.
  - **pageSize** (number) - The number of results in this response.
- **tasks** (array<object>) - Required - Recurring tasks for the workspace.
  - **id** (string) - Required - The ID of the recurring task.
  - **name** (string) - Required - The name of the recurring task.
  - **creator** (object) - Required - The user who created the recurring task.
    - **id** (string) - The user id of the creator.
    - **name** (string) - The name of the creator.
    - **email** (string) - The email of the creator.
  - **assignee** (object) - Required - The user assigned to the recurring task.
    - **id** (string) - The user id of the assignee.
    - **name** (string) - The name of the assignee.
    - **email** (string) - The email of the assignee.
  - **project** (object) - The project data.
    - **id** (string) - Required - The ID of the project.
    - **name** (string) - Required - The name of the project.
    - **description** (string) - Required - The HTML contents of the description.
    - **workspaceId** (string) - Required - The ID of the workspace.
    - **status** (object) - The status of the project.
      - **name** (string) - The name of the status.
      - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
      - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.
    - **createdTime** (datetime) - The timestamp when the project was created.
    - **updatedTime** (datetime) - The timestamp when the project was last updated.
    - **customFieldValues** (record<object>) - Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
      - **text** (object) - Text custom field value.
        - **type** (string) - Required - Always "text" for this field type.
        - **value** (string | null) - Text value or null.
      - **number** (object) - Number custom field value.
        - **type** (string) - Required - Always "number" for this field type.
        - **value** (number | null) - Numeric value or null.
      - **url** (object) - URL custom field value.
        - **type** (string) - Required - Always "url" for this field type.
        - **value** (string | null) - URL string or null.
      - **date** (object) - Date custom field value.
        - **type** (string) - Required - Always "date" for this field type.
        - **value** (string | null) - ISO date string or null.
      - **select** (object) - Select custom field value.
        - **type** (string) - Required - Always "select" for this field type.
        - **value** (string | null) - Selected option value or null.
      - **multiSelect** (object) - Multi-select custom field value.
        - **type** (string) - Required - Always "multiSelect" for this field type.
        - **value** (array<string> | null) - Array of selected option values or null.
      - **person** (object) - Person custom field value.
        - **type** (string) - Required - Always "person" for this field type.
        - **value** (object | null) - Person object or null.
          - **id** (string) - Required - User ID of the person.
          - **name** (string) - Required - Name of the person.
          - **email** (string) - Required - Email of the person.
      - **multiPerson** (object) - Multi-person custom field value.
        - **type** (string) - Required - Always "multiPerson" for this field type.
        - **value** (array<object> | null) - Array of person objects or null.
          - **[index]** (object) - Person object.
            - **id** (string) - Required - User ID of the person.
            - **name** (string) - Required - Name of the person.
            - **email** (string) - Required - Email of the person.
      - **email** (object) - Email custom field value.
        - **type** (string) - Required - Always "email" for this field type.
        - **value** (string | null) - Email address or null.
      - **phone** (object) - Phone custom field value.
        - **type** (string) - Required - Always "phone" for this field type.
        - **value** (string | null) - Phone number or null.

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.
```

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

### GET /v1/tasks/{id}

Source: https://docs.usemotion.com/api-reference/tasks/get

Retrieves a single task by its ID. Requires an API key for authorization.

```APIDOC
## GET /v1/tasks/{id}

### Description
Get a task.

### Method
GET

### Endpoint
/v1/tasks/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The id of the task to fetch.

#### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **id** (string) - Required - The ID of the task.
- **name** (string) - Required - The name of the task.
- **description** (string) - Required - The HTML contents of the description.
- **duration** (string | number) - An integer greater than 0 (representing minutes), "NONE", or "REMINDER".
- **dueDate** (datetime) - When is the task due.
- **deadlineType** (string) - Required - Values are HARD, SOFT (default) or NONE.
- **parentRecurringTaskId** (string) - Required - If this is an instance of a recurring task, this field will be the parent recurring task id.
- **completed** (boolean) - Required - Whether the task is completed or not.
- **completedTime** (datetime) - The timestamp when the task was completed.
- **updatedTime** (datetime) - The timestamp when the task was last updated.
- **startOn** (string) - Date indicating when a task should start, in YYYY-MM-DD format.
- **creator** (object) - Required - The user who created the task.
  - **id** (string) - The user id of the creator.
  - **name** (string) - The name of the creator.
  - **email** (string) - The email of the creator.
- **project** (object) - The project data.
  - **id** (string) - Required - The ID of the project.
  - **name** (string) - Required - The name of the project.
  - **description** (string) - Required - The HTML contents of the description.
  - **workspaceId** (string) - Required - The ID of the workspace.
  - **status** (object) - The status of the project.
    - **name** (string) - The name of the status.
    - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
    - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.
  - **createdTime** (datetime) - The timestamp when the project was created.
  - **updatedTime** (datetime) - The timestamp when the project was last updated.
  - **customFieldValues** (record<object>) - Record of custom field values for the entity, where each key is the name of the custom field (not the ID). Each object contains a "type" discriminator and a "value" property that varies based on the field type.
    - **text** (object) - Text custom field value.
      - **type** (string) - Required - Always "text" for this field type.
      - **value** (string | null) - Text value or null.
    - **number** (object) - Number custom field value.
      - **type** (string) - Required - Always "number" for this field type.
      - **value** (number | null) - Numeric value or null.
    - **url** (object) - URL custom field value.
      - **type** (string) - Required - Always "url" for this field type.
      - **value** (string | null) - URL string or null.
    - **date** (object) - Date custom field value.
      - **type** (string) - Required - Always "date" for this field type.
      - **value** (string | null) - ISO date string or null.
    - **select** (object) - Select custom field value.
      - **type** (string) - Required - Always "select" for this field type.
      - **value** (string | null) - Selected option value or null.
    - **multiSelect** (object) - Multi-select custom field value.
      - **type** (string) - Required - Always "multiSelect" for this field type.
      - **value** (array<string> | null) - Array of selected option values or null.
    - **person** (object) - Person custom field value.
      - **type** (string) - Required - Always "person" for this field type.
      - **value** (object | null) - Person object or null.
        - **id** (string) - Required - User ID of the person.
        - **name** (string) - Required - Name of the person.
        - **email** (string) - Required - Email of the person.
    - **multiPerson** (object) - Multi-person custom field value.
      - **type** (string) - Required - Always "multiPerson" for this field type.
      - **value** (array<object> | null) - Array of person objects or null.
        - **[index]** (object) - Person object.
          - **id** (string) - Required - User ID of the person.
          - **name** (string) - Required - Name of the person.
          - **email** (string) - Required - Email of the person.
    - **email** (object) - Email custom field value.
      - **type** (string) - Required - Always "email" for this field type.
      - **value** (string | null) - Email address or null.
    - **phone** (object) - Phone custom field value.
      - **type** (string) - Required - Always "phone" for this field type.
      - **value** (string | null) - Phone number or null.
    - **checkbox** (object) - Checkbox custom field value.
      - **type** (string) - Required - Always "checkbox" for this field type.
      - **value** (boolean | null) - Boolean value or null.

#### Response Example
```json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "duration": "string | number",
  "dueDate": "datetime",
  "deadlineType": "string",
  "parentRecurringTaskId": "string",
  "completed": true,
  "completedTime": "datetime",
  "updatedTime": "datetime",
  "startOn": "string",
  "creator": {
    "id": "string",
    "name": "string",
    "email": "string"
  },
  "project": {
    "id": "string",
    "name": "string",
    "description": "string",
    "workspaceId": "string",
    "status": {
      "name": "string",
      "isDefaultStatus": true,
      "isResolvedStatus": true
    },
    "createdTime": "datetime",
    "updatedTime": "datetime",
    "customFieldValues": {
      "text": {
        "type": "text",
        "value": "string | null"
      },
      "number": {
        "type": "number",
        "value": 0
      },
      "url": {
        "type": "url",
        "value": "string | null"
      },
      "date": {
        "type": "date",
        "value": "string | null"
      },
      "select": {
        "type": "select",
        "value": "string | null"
      },
      "multiSelect": {
        "type": "multiSelect",
        "value": ["string"]
      },
      "person": {
        "type": "person",
        "value": {
          "id": "string",
          "name": "string",
          "email": "string"
        }
      },
      "multiPerson": {
        "type": "multiPerson",
        "value": [
          {
            "id": "string",
            "name": "string",
            "email": "string"
          }
        ]
      },
      "email": {
        "type": "email",
        "value": "string | null"
      },
      "phone": {
        "type": "phone",
        "value": "string | null"
      },
      "checkbox": {
        "type": "checkbox",
        "value": true
      }
    }
  }
}
```
```

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

### GET /beta/workspaces/{workspaceId}/custom-fields

Source: https://docs.usemotion.com/api-reference/custom-fields/get

Retrieves all custom fields for a specified workspace. Requires an API key for authorization.

```APIDOC
## GET /beta/workspaces/{workspaceId}/custom-fields

### Description
Get all custom fields for a given workspace.

### Method
GET

### Endpoint
`/beta/workspaces/{workspaceId}/custom-fields`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The workspace for which all custom fields should be retrieved.

#### Headers
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **id** (string) - Required - The ID of the custom field.
- **field** (string) - Required - The type of custom field. "text", "url", "date", "person", "multiPerson", "phone", "select", "multiSelect", "number", "email", "checkbox", and "relatedTo" are all valid options.

#### Response Example
```json
[
  {
    "id": "string",
    "field": "string"
  }
]
```
```

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

### GET /v1/users/me

Source: https://docs.usemotion.com/api-reference/users/me

Retrieves information about the user associated with the provided API key.

```APIDOC
## GET /v1/users/me

### Description
Get information on the owner of this API key.

### Method
GET

### Endpoint
/v1/users/me

### Parameters
#### Header Parameters
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **id** (string) - Required - The user ID.
- **name** (string) - The name of the user.
- **email** (string) - Required - The email of the user.

#### Response Example
{
  "id": "string",
  "name": "string",
  "email": "string"
}
```

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

### GET /v1/statuses

Source: https://docs.usemotion.com/api-reference/statuses/get

Retrieves a list of statuses for a particular workspace. Requires an API key in the X-API-Key header and a workspaceId query parameter.

```APIDOC
## GET /v1/statuses

### Description
Get a list of statuses for a particular workspace.

### Method
GET

### Endpoint
/v1/statuses

### Parameters
#### Query Parameters
- **workspaceId** (string) - Required - Get statuses for a particular workspace.

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **status** (object) - Required - The status of the item.
  - **name** (string) - The name of the status.
  - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
  - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.

#### Response Example
```json
[
  {
    "status": {
      "name": "In Progress",
      "isDefaultStatus": false,
      "isResolvedStatus": false
    }
  }
]
```
```

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

### GET /v1/workspaces

Source: https://docs.usemotion.com/api-reference/workspaces/get

Retrieves a list of workspaces the user is a part of. Supports pagination with a cursor and optional filtering by workspace IDs.

```APIDOC
## GET /v1/workspaces

### Description
Get a list of workspaces a user is a part of.

### Method
GET

### Endpoint
`/v1/workspaces`

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Use if a previous request returned a cursor. Will page through results.
- **ids** (array<string>) - Optional - Expand details of specific workspaces, instead of getting all of them.

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200) - application/json - object
- **meta** (object) - Required - Contains the nextCursor, if one exists, along with the pageSize.
  - **nextCursor** (string) - Make the same query with the new cursor to get more results.
  - **pageSize** (number) - The number of results in this response.
- **workspaces** (array<object>) - Required - An array of workspace objects.
  - **id** (string) - Required - The ID of the workspace.
  - **name** (string) - Required - The name of the workspace.
  - **teamId** (string) - Required - The ID of the team.
  - **type** (string) - Required - Whether the workspace is a team or individual type.
  - **labels** (array<object>) - Required - An array of labels.
    - **name** (string) - The name of the label.
  - **statuses** (array<object>) - Required - An array of statuses for the workspace.
    - **name** (string) - The name of the status.
    - **isDefaultStatus** (boolean) - Whether this status is a default status for the workspace.
    - **isResolvedStatus** (boolean) - Whether this is a resolved (terminated) status for the workspace.

#### Response Example
```json
{
  "meta": {
    "nextCursor": "string",
    "pageSize": 0
  },
  "workspaces": [
    {
      "id": "string",
      "name": "string",
      "teamId": "string",
      "type": "string",
      "labels": [
        {
          "name": "string"
        }
      ],
      "statuses": [
        {
          "name": "string",
          "isDefaultStatus": true,
          "isResolvedStatus": true
        }
      ]
    }
  ]
}
```
```

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

### GET /v1/users

Source: https://docs.usemotion.com/api-reference/users/get

Retrieves a list of users for a specified workspace or team. Requires an API key in the X-API-Key header. Supports pagination via a cursor and filtering by team or workspace ID.

```APIDOC
## GET /v1/users

### Description
Get a list of users for a given workspace or team.

### Method
GET

### Endpoint
/v1/users

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Use if a previous request returned a cursor. Will page through results.
- **teamId** (string) - Optional - The ID of the team for which all members will be returned.
- **workspaceId** (string) - Optional - The ID of the workspace for which all members will be returned.

### Authorization
- **X-API-Key** (string) - Required - Header with the name `X-API-Key` where the value is your API key.

### Response
#### Success Response (200)
- **meta** (object) - Required - Contains the nextCursor, if one exists, along with the pageSize.
  - **nextCursor** (string) - Make the same query with the new cursor to get more results.
  - **pageSize** (number) - The number of results in this response.
- **users** (array<object>) - Required - An array of user objects.
  - **id** (string) - Required - The user ID.
  - **name** (string) - The name of the user.
  - **email** (string) - Required - The email of the user.
```
Tokens:
Raw