---
updatedAt: 2026-05-28T05:06:14.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Returns Assignments associated with a single Onboarding Process

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "description": "SmartOnboard Public API",
    "version": "1.0.0",
    "title": "SmartOnboard",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "tags": [
    {
      "name": "assignments",
      "description": "API to manage New Hire Assignments"
    }
  ],
  "paths": {
    "/onboarding-processes/{onboardingProcessId}/assignments": {
      "parameters": [
        {
          "$ref": "#/components/parameters/OnboardingProcessId"
        },
        {
          "$ref": "#/components/parameters/IntegrationRelevantAssignmentsFlag"
        }
      ],
      "get": {
        "responses": {
          "200": {
            "description": "Assignments associated with the given Onboarding Process were returned",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Assignments"
                }
              }
            }
          },
          "401": {
            "description": "With codes: * **NOT_AUTHORIZED_TO_ACCESS_RESOURCE** when caller is not authorized to access resource\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "With codes:\n* **'ONBOARDING_PROCESS_NOT_FOUND'** when there is no Onboarding Process for given id\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        },
        "tags": [
          "assignments"
        ],
        "summary": "Returns Assignments associated with a single Onboarding Process",
        "operationId": "onboarding-processes.assignments.get",
        "security": [
          {
            "key": []
          },
          {
            "oauth": [
              "assignments_read"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "OnboardingProcessId": {
        "in": "path",
        "name": "onboardingProcessId",
        "description": "ID of the Onboarding Process",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/Uuid"
        }
      },
      "IntegrationRelevantAssignmentsFlag": {
        "in": "query",
        "name": "integrationRelevant",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "description": "Indicate if only assignments that have integration key defined should be fetched. By default set to false"
      }
    },
    "responses": {
      "ServerError": {
        "description": "Unexpected error"
      }
    },
    "schemas": {
      "Uuid": {
        "type": "string",
        "format": "uuid"
      },
      "Assignments": {
        "type": "object",
        "required": [
          "activityAssignments",
          "webFormAssignments",
          "fillablePdfFormAssignments"
        ],
        "properties": {
          "activityAssignments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ActivityAssignment"
            }
          },
          "webFormAssignments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebFormAssignment"
            }
          },
          "fillablePdfFormAssignments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FillablePdfFormAssignment"
            }
          }
        }
      },
      "ActivityAssignment": {
        "type": "object",
        "required": [
          "id",
          "title",
          "type",
          "description",
          "isFileUploadRequired",
          "hasSensitiveData",
          "isHighPriority"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "isFileUploadRequired": {
            "type": "boolean"
          },
          "hasSensitiveData": {
            "type": "boolean"
          },
          "isHighPriority": {
            "type": "boolean"
          },
          "integrationKey": {
            "type": "string"
          }
        }
      },
      "WebFormAssignment": {
        "type": "object",
        "required": [
          "id",
          "title",
          "type",
          "description",
          "hasSensitiveData",
          "isHighPriority"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "hasSensitiveData": {
            "type": "boolean"
          },
          "isHighPriority": {
            "type": "boolean"
          },
          "integrationKey": {
            "type": "string"
          }
        }
      },
      "FillablePdfFormAssignment": {
        "type": "object",
        "required": [
          "id",
          "title",
          "type",
          "description",
          "hasSensitiveData",
          "isHighPriority",
          "fileName"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "hasSensitiveData": {
            "type": "boolean"
          },
          "isHighPriority": {
            "type": "boolean"
          },
          "fileName": {
            "type": "string"
          },
          "integrationKey": {
            "type": "string"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "x-smarttoken"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.smartrecruiters.com/smartonboard-api/v202205"
    }
  ]
}
```