---
updatedAt: 2026-04-27T23:21:35.000Z
agentTools:
  projectIndex: https://developer.runn.io/llms.txt
---

# List assignments

Get a list of assignments, paginated. [Learn more](https://developer.runn.io/docs/assignments).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Runn API",
    "version": "1.0.0",
    "description": "<p>See <a target=\"_blank\" href=\"https://help.runn.io/en/articles/8579592-api-v1-beta\" title=\"Runn API full documentation\">the full documentation and guide</a> to using the Runn API.</p><p>The domain for your API endpoint can be found in <strong>Accounts > Settings > API</strong> in your Runn application</p>"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "Assignment": {
        "type": "object",
        "required": [
          "id",
          "personId",
          "startDate",
          "endDate",
          "projectId",
          "minutesPerDay",
          "roleId",
          "isActive",
          "note",
          "isBillable",
          "phaseId",
          "isNonWorkingDay",
          "isTemplate",
          "isPlaceholder",
          "workstreamId",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "description": "The unique identifier for the assignment.",
            "type": "integer"
          },
          "personId": {
            "description": "id referencing the person associated with the assignment.",
            "type": "integer"
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "description": "The start date of the assignment. Format: YYYY-MM-DD"
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "description": "The end date of the assignment. Format: YYYY-MM-DD"
          },
          "projectId": {
            "description": "The ID referencing the project to which the assignment belongs.",
            "type": "integer"
          },
          "minutesPerDay": {
            "description": "The number of minutes allocated to the assignment per day.",
            "type": "integer"
          },
          "roleId": {
            "description": "The ID referencing the role associated with the assignment.",
            "type": "integer"
          },
          "isActive": {
            "description": "A flag indicating whether the assignment is currently active. (Deprecated. Assignments are always hard delete so are now always active).",
            "deprecated": true,
            "type": "boolean"
          },
          "note": {
            "type": "string",
            "nullable": true
          },
          "isBillable": {
            "description": "A flag indicating whether the assignment is billable.",
            "type": "boolean"
          },
          "phaseId": {
            "type": "integer",
            "nullable": true
          },
          "isNonWorkingDay": {
            "description": "A flag indicating if the assignment falls on a non-working day.",
            "type": "boolean"
          },
          "isTemplate": {
            "description": "A flag indicating if the assignment is a template.",
            "type": "boolean"
          },
          "isPlaceholder": {
            "description": "A flag indicating if the assignment's person is a placeholder.",
            "type": "boolean"
          },
          "workstreamId": {
            "type": [
              "number",
              "null"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the object was created."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the object was last updated."
          }
        }
      },
      "BadRequest": {
        "type": "object",
        "required": [
          "error",
          "message",
          "statusCode"
        ],
        "properties": {
          "error": {
            "type": "string",
            "enum": [
              "Bad Request"
            ]
          },
          "message": {
            "type": "string"
          },
          "statusCode": {
            "type": "number",
            "enum": [
              400
            ]
          }
        }
      },
      "ModifiedAfter": {
        "description": "If provided, will only return objects modified after this timestamp. Format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.",
        "anyOf": [
          {
            "format": "date",
            "type": "string"
          },
          {
            "format": "date-time",
            "type": "string"
          }
        ]
      },
      "Unauthorized": {
        "type": "object",
        "required": [
          "error",
          "message",
          "statusCode"
        ],
        "properties": {
          "error": {
            "type": "string",
            "enum": [
              "Unauthorized"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Unauthorized"
            ]
          },
          "statusCode": {
            "type": "number",
            "enum": [
              401
            ]
          }
        }
      }
    }
  },
  "paths": {
    "/assignments/": {
      "get": {
        "operationId": "listAssignments",
        "summary": "List assignments",
        "description": "Get a list of assignments, paginated. [Learn more](https://developer.runn.io/docs/assignments).",
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "cursor",
            "required": false,
            "description": "Cursor for paginated requests"
          },
          {
            "schema": {
              "default": 100,
              "minimum": 1,
              "maximum": 200,
              "type": "integer"
            },
            "in": "query",
            "name": "limit",
            "required": false,
            "description": "The number of results per page"
          },
          {
            "schema": {
              "type": "string",
              "enum": [
                "createdAt",
                "updatedAt",
                "id"
              ],
              "default": "id"
            },
            "in": "query",
            "name": "sortBy",
            "required": false,
            "description": "Field to sort by: createdAt or updatedAt or id"
          },
          {
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "asc"
            },
            "in": "query",
            "name": "order",
            "required": false,
            "description": "Sort order: asc or desc"
          },
          {
            "schema": {
              "type": "integer"
            },
            "in": "query",
            "name": "personId",
            "required": false
          },
          {
            "schema": {
              "type": "integer"
            },
            "in": "query",
            "name": "roleId",
            "required": false
          },
          {
            "schema": {
              "type": "integer"
            },
            "in": "query",
            "name": "projectId",
            "required": false
          },
          {
            "schema": {
              "type": "string",
              "format": "date"
            },
            "in": "query",
            "name": "startDate",
            "required": false,
            "description": "Format: YYYY-MM-DD"
          },
          {
            "schema": {
              "type": "string",
              "format": "date"
            },
            "in": "query",
            "name": "endDate",
            "required": false,
            "description": "Format: YYYY-MM-DD"
          },
          {
            "schema": {
              "$ref": "#/components/schemas/ModifiedAfter"
            },
            "in": "query",
            "name": "modifiedAfter",
            "required": false
          },
          {
            "schema": {
              "default": "1.0.0",
              "enum": [
                "1.0.0"
              ]
            },
            "in": "header",
            "name": "accept-version",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "values",
                    "nextCursor"
                  ],
                  "properties": {
                    "values": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Assignment"
                      }
                    },
                    "nextCursor": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequest"
                }
              }
            }
          },
          "401": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.runn.io",
      "description": "EU Server"
    },
    {
      "url": "https://api.us.runn.io",
      "description": "US Server"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "proxy-enabled": false
  }
}
```