SIsignalshq
CLIENT
Intake Requests

List Intake Requests

List all intake requests for a client with optional status filtering.

get/internal/api/clients/{client_id}/intake-requests

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_idstring uuid required

Client ID

Query parameters

status_filterstring nullable
limitinteger
offsetinteger

Response

Successful Response

idstring uuid required

Unique identifier for the upload request

request_titlestring required

Title of the upload request

status'DRAFT' | 'EMAIL_SENT' | 'ACTIVE' | 'COMPLETED' | 'EXPIRED' | 'REVOKED' required

Enum for intake request status

total_itemsinteger required

Total number of items requested

completed_itemsinteger required

Number of items completed

expires_atstring date-time required

When the upload link expires

created_atstring date-time required

When the request was created

created_bystring required

User who created the request

questionnaire_from_pyrstring nullable

Questionnaire processing status for previous year return (if applicable for this intake request)

document_checklist_suggestionstring nullable

Document checklist processing status for previous year return (if applicable for this intake request)

Example response

[
  {
    "questionnaire_from_pyr": "COMPLETED",
    "document_checklist_suggestion": "COMPLETED"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.