SIsignalshq
CLIENT
Client Management

List Clients

Get a paginated list of clients with optional filtering and sorting.

get/internal/api/clients/

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

Query parameters

status'DRAFT' | 'ACTIVE' | 'INACTIVE'

Filter by status (ACTIVE, DRAFT, INACTIVE)

filing_type'INDIVIDUAL_1040' | 'SOLO_SCHEDULE_C'

Filter by filing type

filing_status'SINGLE' | 'MARRIED_FILING_JOINTLY' | 'MARRIED_FILING_SEPARATELY' | 'HEAD_OF_HOUSEHOLD' | 'QUALIFYING_SURVIVING_SPOUSE'

Filter by filing status

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page (max 100)

sort_by'created_at' | 'name' | 'email' | 'readable_id' | 'filing_type' | 'filing_status'

Client sort field enumeration

Field to sort by (created_at, name, email, readable_id)

sort_order'asc' | 'desc'

Sort order enumeration

Sort order

search_querystring nullable

Search term

Response

Successful Response

Example response

{
  "clients": [
    {
      "filing_type": {
        "label": "Individual (Form 1040)",
        "value": "INDIVIDUAL_1040"
      },
      "filing_status": {
        "label": "Single",
        "value": "SINGLE"
      },
      "ssn_info": {
        "entity_type": "CLIENT",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "ssn_masked": "XXX-XX-1234",
        "ssn_type": "SSN"
      }
    }
  ]
}

Changes

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