> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt > Use this file to discover all available pages before exploring further. # List signing requests > Returns a list of signing requests. Uses cursor pagination. Optionally filter by attachment IDs. ## OpenAPI ````yaml /openapi-private.json get /attachments/signing-requests openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /attachments/signing-requests: get: tags: - Attachments summary: List signing requests description: >- Returns a list of signing requests. Uses cursor pagination. Optionally filter by attachment IDs. operationId: getSigningRequests parameters: - name: limit required: false in: query description: >- Number of signing requests to return per page (min: 1, max: 50, default: 25). schema: minimum: 1 maximum: 50 default: 25 example: 25 type: integer - name: cursor required: false in: query description: >- Opaque cursor string for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page. schema: type: string - name: modifiedSince required: false in: query description: >- Filter signing requests modified on or after this date. Useful for incremental synchronization. Defaults to the beginning of time if not provided. schema: $ref: '#/components/schemas/DateISO' default: '1970-01-01T00:00:00.000Z' example: '2024-11-01T00:00:00.000Z' - name: attachmentIds required: false in: query description: >- Filter signing requests to those that reference at least one of the given attachment IDs. schema: minItems: 1 maxItems: 100 uniqueItems: true example: - attachment-123 - attachment-456 type: array items: type: string responses: '200': description: >- Successfully retrieved signing requests. Returns items with pagination info containing the cursor for the next page. content: application/json: schema: $ref: '#/components/schemas/GetSigningRequestsResponseDto' '400': description: >- Bad request - invalid query parameters (e.g., limit out of range, invalid date format) content: application/json: schema: allOf: - $ref: '#/components/schemas/ExceptionBaseDto' - type: object properties: statusCode: type: number example: 400 message: type: string example: Limit must be between 1 and 50 error: type: string example: Bad Request '401': description: Unauthorized - invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' security: - x-api-key: [] components: schemas: DateISO: id: DateISO format: date-time anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ GetSigningRequestsResponseDto: type: object properties: items: type: array items: $ref: '#/components/schemas/AttachmentSigningRequestDto' pagination: $ref: '#/components/schemas/SigningRequestCursorPaginationDto' required: - items - pagination id: PrivateGetSigningRequestsResponseDto ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string required: - status - message - requestId id: ExceptionBaseDto AttachmentSigningRequestDto: type: object properties: id: type: string provider: type: string enum: - DOCUSIGN - NITRO envelopeId: anyOf: - type: string - type: 'null' status: type: string enum: - CREATED - SENT - DELIVERED - COMPLETED - DECLINED - VOIDED - EXPIRED - FAILED sender: $ref: '#/components/schemas/UserBadgeDto' sentAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' completedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' createdAt: $ref: '#/components/schemas/DateISO' recipients: type: array items: $ref: '#/components/schemas/AttachmentSigningRecipientDto' documents: type: array items: $ref: '#/components/schemas/AttachmentDto' required: - id - provider - envelopeId - status - sender - sentAt - completedAt - createdAt - recipients - documents id: PrivateAttachmentSigningRequestDto SigningRequestCursorPaginationDto: type: object properties: cursor: anyOf: - type: string - type: 'null' required: - cursor id: PrivateSigningRequestCursorPaginationDto UserBadgeDto: type: object properties: id: type: string name: type: string avatarUrl: anyOf: - type: string - type: 'null' deactivatedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' required: - id - name - avatarUrl - deactivatedAt id: PrivateUserBadgeDto AttachmentSigningRecipientDto: type: object properties: id: type: string status: type: string enum: - CREATED - SENT - DELIVERED - SIGNED - COMPLETED - DECLINED - AUTO_RESPONDED - FAILED name: type: string emailAddress: type: string signedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' declinedAt: anyOf: - $ref: '#/components/schemas/DateISO' - type: 'null' candidate: anyOf: - $ref: '#/components/schemas/IdDto' - type: 'null' clientContact: anyOf: - $ref: '#/components/schemas/IdDto' - type: 'null' required: - id - status - name - emailAddress - signedAt - declinedAt - candidate - clientContact id: PrivateAttachmentSigningRecipientDto AttachmentDto: type: object properties: attachmentId: type: string attachmentName: anyOf: - type: string - type: 'null' type: anyOf: - type: string enum: - UNASSIGNED - CV - type: 'null' customType: anyOf: - $ref: '#/components/schemas/AttachmentCustomTypeDto' - type: 'null' createdAt: $ref: '#/components/schemas/DateISO' extension: anyOf: - type: string - type: 'null' size: anyOf: - type: number - type: 'null' required: - attachmentId - attachmentName - type - customType - createdAt - extension - size id: PrivateAttachmentDto IdDto: type: object properties: id: type: string minLength: 1 required: - id id: IdDto AttachmentCustomTypeDto: type: object properties: id: type: string name: type: string required: - id - name id: PrivateAttachmentCustomTypeDto securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard. ````