List Organizations
Returns a list of all organizations in your account.
Endpoint
GET /api/organizations
Authentication
Requires API Key authentication.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 100 | Maximum number of organizations to return |
offset | integer | 0 | Number of organizations to skip (for pagination) |
search | string | Case-insensitive search on organization name |
Response
Returns an object with an organizations array and a total count.
{
"success": true,
"data": {
"organizations": [
{
"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"
},
{
"id": "org_def456ghi789",
"account_id": "acc_xyz789",
"name": "Johnson Legal Group",
"phone_number": "555-987-6543",
"street_address": "456 Oak Avenue",
"city": "Los Angeles",
"state": "CA",
"zip_code": "90001",
"country": "United States",
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"total": 2
}
}
Example
curl -X GET "https://api.silentwitness.ai/api/organizations" \
-H "X-API-Key: $API_KEY"
With Pagination
curl -X GET "https://api.silentwitness.ai/api/organizations?limit=10&offset=10" \
-H "X-API-Key: $API_KEY"
With Search
curl -X GET "https://api.silentwitness.ai/api/organizations?search=Smith" \
-H "X-API-Key: $API_KEY"
Response Fields
| Field | Type | Description |
|---|---|---|
organizations | array | Array of organization objects |
organizations[].id | string | Unique organization identifier |
organizations[].account_id | string | Account this organization belongs to |
organizations[].name | string | Organization name |
organizations[].phone_number | string | Primary contact phone number |
organizations[].street_address | string | Physical street address |
organizations[].city | string | City |
organizations[].state | string | State or province |
organizations[].zip_code | string | ZIP or postal code |
organizations[].country | string | Country |
organizations[].created_at | datetime | When the organization was created |
organizations[].updated_at | datetime | When the organization was last updated |
total | integer | Total number of organizations matching the query (for pagination) |
Errors
error_code | HTTP | error_type | Meaning |
|---|---|---|---|
org_list_failed | 500 | api_error | Unexpected server error while listing organizations. Include request_id when contacting support. |