Skip to main content

Organizations API

Organizations represent law firms, companies, or business entities in Silent Witness. They help you organize cases and manage billing.

Endpoints

MethodEndpointDescription
POST/api/organizationsCreate organization
GET/api/organizations/:idGet organization
GET/api/organizationsList organizations
PUT/api/organizations/:idUpdate organization
DELETE/api/organizations/:idDelete organization

Organization Object

{
"id": "org_abc123def456",
"account_id": "acc_xyz789",
"name": "Smith & Associates Law Firm",
"phone_number": "555-123-4567",
"street_address": "123 Main Street, Suite 400",
"city": "San Francisco",
"state": "CA",
"zip_code": "94102",
"country": "United States",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}

Fields

FieldTypeDescription
idstringUnique organization identifier
account_idstringAccount this organization belongs to
namestringOrganization name
phone_numberstringPrimary contact phone number
street_addressstringPhysical street address
citystringCity
statestringState or province
zip_codestringZIP or postal code
countrystringCountry
created_atdatetimeWhen the organization was created
updated_atdatetimeWhen the organization was last updated

Workflow

  1. Create an organization with your firm's details
  2. Create cases within the organization by passing the organization_id
  3. List organizations to view all firms in your account
  4. Update an organization when contact details change
  5. Delete an organization when it is no longer needed

Use Cases

  • Law firms: Create an organization for each law firm you work with
  • Multi-office: Create separate organizations for different office locations
  • Client segregation: Organize cases by client organization

Next Steps