Search Clients

Search clients with filters and pagination.

post/internal/api/clients/search

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

Request body

search_querystring nullable

Search by name, email, or readable_id

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

filing_type'INDIVIDUAL_1040' | 'SOLO_SCHEDULE_C'

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

pageinteger

Page number

page_sizeinteger

Items per page

sort_bystring

Sort field (created_at, name, email, readable_id, filing_type, filing_status)

sort_orderstring

Sort order (asc, desc)

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.