Skip to main content

List Organizations

Returns a list of all organizations in your account.

Endpoint

GET /api/organizations

Authentication

Requires API Key authentication.

Query Parameters

ParameterTypeDefaultDescription
limitinteger100Maximum number of organizations to return
offsetinteger0Number of organizations to skip (for pagination)
searchstringCase-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"
curl -X GET "https://api.silentwitness.ai/api/organizations?search=Smith" \
-H "X-API-Key: $API_KEY"

Response Fields

FieldTypeDescription
organizationsarrayArray of organization objects
organizations[].idstringUnique organization identifier
organizations[].account_idstringAccount this organization belongs to
organizations[].namestringOrganization name
organizations[].phone_numberstringPrimary contact phone number
organizations[].street_addressstringPhysical street address
organizations[].citystringCity
organizations[].statestringState or province
organizations[].zip_codestringZIP or postal code
organizations[].countrystringCountry
organizations[].created_atdatetimeWhen the organization was created
organizations[].updated_atdatetimeWhen the organization was last updated
totalintegerTotal number of organizations matching the query (for pagination)

Errors

error_codeHTTPerror_typeMeaning
org_list_failed500api_errorUnexpected server error while listing organizations. Include request_id when contacting support.