# Get client by ID Retrieve a specific client by its unique identifier This endpoint provides detailed client information including: - Complete client details and demographics - Client status and relationship information - Contact and address information - Engagement and project portfolio - Financial and billing information - Industry and business classification Client Management Features: - Client lifecycle tracking - Relationship management - Contact and address management - Engagement portfolio oversight - Financial and billing setup Client Details Include: - Client name and demographics - Client status and type - Contact information - Address and location - Engagement portfolio - Financial information Business Applications: - Client relationship management - Engagement portfolio analysis - Financial performance tracking - Contact management - Business development planning Real Example: bash curl --location 'https://{{host}}/v1/client/789' \ --header 'Authorization: bearer {{token}}' \ --header 'Content-Type: application/json' Response Example: json { "id": 789, "name": "Acme Corporation", "legalName": "Acme Corporation, Inc.", "status": "ACTIVE", "type": "CORPORATE", "industry": "MANUFACTURING", "size": "LARGE", "website": "https://www.acme.com", "taxId": "12-3456789", "phone": "+1-555-0123", "email": "info@acme.com", "address": { "street": "123 Business Ave", "city": "New York", "state": "NY", "zipCode": "10001", "country": "USA" }, "billingAddress": { "street": "456 Finance Blvd", "city": "New York", "state": "NY", "zipCode": "10002", "country": "USA" }, "primaryContact": { "id": 23456, "name": "John Smith", "title": "Chief Financial Officer", "email": "john.smith@acme.com", "phone": "+1-555-0123" }, "engagements": [ { "id": 34567, "name": "Annual Audit Engagement 2024", "status": "ACTIVE", "type": "AUDIT", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-12-31T23:59:59Z" } ], "financialSummary": { "totalRevenue": 150000.00, "outstandingBalance": 25000.00, "currency": "USD", "lastPaymentDate": "2024-11-15T10:30:00Z" }, "notes": "Long-term client with excellent payment history and strong relationship", "createdAt": "2020-01-15T10:00:00Z", "updatedAt": "2024-11-20T14:30:00Z" } Endpoint: GET /gql/v1/client/{id} Version: 1.0.0 Security: BearerAuth ## Path parameters: - `id` (integer, required) Unique identifier of the client Example: 789 ## Response 200 fields (application/json): - `id` (integer) Unique client identifier Example: 789 - `name` (string) Client name Example: "Acme Corporation" - `legalName` (string) Legal business name Example: "Acme Corporation, Inc." - `status` (string) Client status Enum: "ACTIVE", "INACTIVE", "PROSPECT", "FORMER" - `type` (string) Client type Enum: "CORPORATE", "INDIVIDUAL", "PARTNERSHIP", "LLC", "NONPROFIT" - `industry` (string) Industry classification Enum: "MANUFACTURING", "RETAIL", "HEALTHCARE", "FINANCIAL", "TECHNOLOGY", "CONSULTING", "OTHER" - `size` (string) Company size classification Enum: "SMALL", "MEDIUM", "LARGE", "ENTERPRISE" - `website` (string) Company website URL Example: "https://www.acme.com" - `taxId` (string) Tax identification number Example: "12-3456789" - `phone` (string) Primary phone number Example: "+1-555-0123" - `email` (string) Primary email address Example: "info@acme.com" - `address` (object) Primary business address - `address.street` (string) Street address Example: "123 Business Ave" - `address.city` (string) City Example: "New York" - `address.state` (string) State or province Example: "NY" - `address.zipCode` (string) ZIP or postal code Example: "10001" - `address.country` (string) Country Example: "USA" - `billingAddress` (object) Billing address (if different from primary) - `primaryContact` (object) Primary contact information - `primaryContact.id` (integer) Contact identifier Example: 23456 - `primaryContact.name` (string) Contact name Example: "John Smith" - `primaryContact.title` (string) Contact title Example: "Chief Financial Officer" - `primaryContact.email` (string) Contact email Example: "john.smith@acme.com" - `primaryContact.phone` (string) Contact phone Example: "+1-555-0123" - `engagements` (array) Active engagements for this client - `engagements.id` (integer) Engagement identifier Example: 34567 - `engagements.name` (string) Engagement name Example: "Annual Audit Engagement 2024" - `engagements.status` (string) Engagement status Enum: "PLANNING", "ACTIVE", "ON_HOLD", "COMPLETED", "CANCELLED" - `engagements.type` (string) Engagement type Enum: "AUDIT", "REVIEW", "COMPILATION", "TAX", "CONSULTING", "ADVISORY" - `engagements.startDate` (string) Engagement start date Example: "2024-01-01T00:00:00Z" - `engagements.endDate` (string) Engagement end date Example: "2024-12-31T23:59:59Z" - `financialSummary` (object) Financial summary for this client - `financialSummary.totalRevenue` (number) Total revenue from this client Example: 150000 - `financialSummary.outstandingBalance` (number) Outstanding balance owed Example: 25000 - `financialSummary.currency` (string) Currency code Example: "USD" - `financialSummary.lastPaymentDate` (string) Date of last payment Example: "2024-11-15T10:30:00Z" - `notes` (string) Additional notes about the client Example: "Long-term client with excellent payment history and strong relationship" - `createdAt` (string) Client creation timestamp Example: "2020-01-15T10:00:00Z" - `updatedAt` (string) Last update timestamp Example: "2024-11-20T14:30:00Z" ## Response 404 fields (application/json): - `error` (string) Example: "Client not found" - `message` (string) Example: "Client with ID 789 does not exist" ## Response 401 fields ## Response 403 fields ## Response 500 fields