> ## Documentation Index > Fetch the complete documentation index at: https://developers.gonitro.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get actors for a user > Retrieves all actors across packages for a specific user, identified by email address. Use the query parameters to page and to filter by status, actor type, creation date and sort order. ## OpenAPI ````yaml /nsev/api-reference/openapi.yaml get /packages/actors openapi: 3.0.0 info: title: NSEV WebPortal API version: 4.0.0 contact: name: NSEV Support Team url: https://connectivegroup.my.site.com/s/contactsupport?language=en_US description: > **Nitro Sign Enterprise Verified (NSEV) WebPortal API Version 4** A comprehensive digital signing API that enables secure document signing workflows. This API provides endpoints for managing packages, documents, elements, stakeholders, and signing processes within the NSEV platform. ## Authentication This API supports multiple authentication methods: ### Basic Authentication Traditional HTTP Basic Authentication using username and password. ### OAuth 2.0 **Client Credentials Flow (Machine-to-Machine)** - Full API access including administrative endpoints - Ideal for server-to-server integrations **Authorization Code Flow (User-based)** - Limited API access excluding administrative endpoints - Ideal for user-facing applications - Supports delegated user access scenarios ## API Variants This specification is available in two variants: - **Full API**: Complete API with all endpoints (BasicAuth + OAuth2 M2M) - **User API**: Limited API excluding admin endpoints (OAuth2 user-based only) Administrative endpoints (`/poisonqueue`, `/absenceperiods`, `/auditproofs`) are restricted to machine-to-machine authentication only. ## Versioning This API follows semantic versioning principles. Major version changes may introduce breaking changes, while minor and patch versions maintain backwards compatibility. servers: - url: '{baseUrl}/esig/webportalapi/v4' variables: baseUrl: default: https://your-tenant.sign.gonitro.com description: >- Your tenant-specific base URL, including scheme and host (e.g. https://acme.sign.gonitro.com). Each NSEV customer has a unique URL. Replace this with yours before sending a request. The esig path segment is required - the Web Application Firewall routes requests on it. security: - basicAuth: [] - bearerAuth: [] tags: - name: Configuration description: | Endpoints for retrieving system configuration settings, contact groups, templates and signing methods. - name: Packages description: | Core endpoints for creating, managing, and tracking packages throughout their lifecycle. - name: Documents description: | Endpoints for adding, removing, and managing documents within packages. Handles document upload, processing, and metadata management. - name: Elements description: | Endpoints for managing elements (fields) within documents, including signatures and other form elements. - name: Stakeholders description: | Endpoints for managing stakeholders (recipients) associated with packages and their roles in the package workflow. - name: Actors description: | Endpoints for managing individual actors within stakeholders, including their contact information and role preferences: Approver, FormFiller, Signer or Receiver - name: Process description: | Endpoints for managing the package process workflow, including process steps, parallel actions, and workflow orchestration. - name: AuditTrails description: | Modern endpoints for retrieving comprehensive audit trails as signed PDFs, verifying the integrity of audit trail data and retrieving audit events. - name: BulkActions description: | Endpoints for performing and managing bulk actions on multiple packages. - name: Users description: | Endpoints for managing user accounts, including user invitations. - name: AbsencePeriods description: | Administrative endpoints for managing user absence periods and delegation settings during out-of-office scenarios. **Access Level**: Machine-to-machine only (administrative access required) paths: /packages/actors: get: tags: - Packages summary: Get actors for a user description: >- Retrieves all actors across packages for a specific user, identified by email address. Use the query parameters to page and to filter by status, actor type, creation date and sort order. parameters: - $ref: '#/components/parameters/emailAddressQueryParam' - name: status in: query description: The status of actors to retrieve schema: type: string enum: - Available - Finished - Rejected - Failed - name: type in: query description: The type of actors to retrieve schema: type: string enum: - Signer - Receiver - Approver - FormFiller - $ref: '#/components/parameters/pageNumber' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/createdBefore' - $ref: '#/components/parameters/createdAfter' - name: sort in: query description: specify how the result is sorted, default is descending schema: type: string default: desc enum: - asc - desc responses: '200': description: List of actors across packages for given person. content: application/json: schema: type: array items: allOf: - $ref: '#/components/schemas/PagingResult' - type: object properties: Items: type: array items: $ref: '#/components/schemas/PackagesActorsInfoResult' '400': $ref: '#/components/responses/ValidationFailed' '401': $ref: '#/components/responses/UnAuthorized' components: parameters: emailAddressQueryParam: name: emailAddress in: query required: true description: The email address of the person schema: $ref: '#/components/schemas/EmailAddress' pageNumber: name: pageNumber in: query description: The page to retrieve schema: type: integer minimum: 0 default: 0 pageSize: name: pageSize in: query description: Maximum number of records in the response schema: type: integer minimum: 1 default: 20 createdBefore: name: createdBefore in: query description: Select items created before given date schema: type: string format: date example: '2020-01-15' createdAfter: name: createdAfter in: query description: Select items created after given date schema: type: string format: date example: '2020-01-14' schemas: PagingResult: type: object description: A list of items properties: PageSize: type: integer description: The requested page size example: 20 Total: type: integer description: The total number of items example: 1 PackagesActorsInfoResult: type: object description: The actors information additionalProperties: false properties: ActorId: $ref: '#/components/schemas/Actor.Id' Status: $ref: '#/components/schemas/Actor.Status' Type: $ref: '#/components/schemas/Actor.Type' StakeholderId: $ref: '#/components/schemas/Stakeholder.Id' PackageId: $ref: '#/components/schemas/Package.Id' PackageName: $ref: '#/components/schemas/Package.Name' CreationDate: $ref: '#/components/schemas/CreationDate' Initiator: $ref: '#/components/schemas/Package.Initiator' Documents: type: array items: properties: Id: $ref: '#/components/schemas/Document.Id' Name: $ref: '#/components/schemas/Document.Name' EmailAddress: title: Email address type: string format: email example: hello@world.test Actor.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: This actor's unique identifier Actor.Status: type: string description: >- The status of an actor's action. - **Draft** - the package is still in draft; the action is not yet active. - **Waiting** - the action is waiting for an earlier process step to complete. - **Available** - the action is ready to be performed. - **InProgress** - the action is being performed. - **Failed** - the action failed. - **Finished** - the action was completed. - **Rejected** - the actor rejected the document. - **Skipped** - the action was skipped (for example via skip approvers/signers). enum: - Draft - Waiting - Available - InProgress - Failed - Finished - Rejected - Skipped Actor.Type: type: string description: >- The type of action an actor performs on a package, and the discriminator across the actor variants. - **FormFiller** - fills TextBoxField, CheckBoxField and RadioGroup elements; does not sign or approve. Must be placed in the first process step. - **Approver** - approves a document as fit for signing, before any signer acts. Must be placed in the first process step (may share it with FormFillers). - **Signer** - signs one or more signing fields. - **Receiver** - receives a copy of the fully signed document; takes no action and must be placed in the last process step. enum: - Signer - Receiver - Approver - FormFiller Stakeholder.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A stakeholder's unique identifier Package.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A package's unique identifier Package.Name: type: string description: >- Name of the package. It is shown in the NSEV WebPortal and used as the file name when the package is downloaded as a `.zip` file, so do not add a file extension. Avoid forbidden file-name characters - slash (`/`), backslash (`\`), question mark (`?`), percent (`%`), asterisk (`*`), colon (`:`), pipe (`|`), single quote, double quote (`"`), less-than (`<`) and greater-than (`>`) - and HTML-sensitive characters such as ampersand (`&`) and apostrophe. This list is not exhaustive. When using itsme signing, use only characters supported by ISO 8859-15; some software-generated characters such as curly apostrophes and long dashes are not supported. nullable: false minLength: 1 maxLength: 150 example: example package CreationDate: type: string format: date-time description: When the resource was created Package.Initiator: allOf: - $ref: '#/components/schemas/EmailAddress' - description: Email address of a known user of the webSigner portal Document.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A document's unique identifier Document.Name: type: string nullable: false description: Name of the document minLength: 1 maxLength: 150 example: example document ValidationError: title: Validation error allOf: - $ref: '#/components/schemas/Error' - description: Request failed validation example: ErrorCode: Name.MinimumLength:6 ErrorMessage: The minimum length for a name is 6 Guid: title: GUID type: string description: A globally unique identifier format: guid example: 00000000-0000-0000-0000-000000000000 Error: title: Error type: object description: Something that went wrong example: ErrorCode: Something.WentWrong ErrorMessage: Something went wrong properties: ErrorCode: type: string description: >- An error code of something that went wrong, in the form of 'Subject.Error:value' ErrorMessage: type: string description: A human-readable explanation of what went wrong responses: ValidationFailed: description: Request failed validation content: application/json: schema: type: array items: $ref: '#/components/schemas/ValidationError' UnAuthorized: description: Caller is unauthorized to perform this operation securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Bearer token authentication using JSON Web Tokens (JWT) or opaque tokens. **Usage**: Send the access token in the Authorization header: ``` Authorization: Bearer ``` ````