Overview

BROSH CRM exposes an OAuth2 integration plus a table-based records API. Supported objects are accessed by passing :tableName in the URL.

Supported Objects

Use these values as :tableName:

Common Fields (Available on All Objects)

All objects in BROSH CRM include the following standard fields, which can be used in queries, filters, and sorting:

OAuth2 Authentication

BROSH CRM provides three OAuth-related endpoints: token exchange, token refresh, and a "me" call to validate tokens.

Exchange Authorization Code → Token

Exchange an OAuth2 authorization code for an access token (and typically a refresh token).

Request (example)

{
 "code": "AUTH_CODE_FROM_BROSH_OAUTH_FLOW",
 "redirect_uri": "https://yourapp.example.com/oauth/callback",
 "client_id": "YOUR_CLIENT_ID",
 "client_secret": "YOUR_CLIENT_SECRET",
 "grant_type": "authorization_code"
}

Response (example)

{
 "access_token": "eyJhbGciOi...",
 "refresh_token": "def50200...",
 "token_type": "Bearer",
 "expires_in": 3600
}

Fields depend on your BROSH OAuth2 configuration; the example matches typical OAuth2 responses.

Refresh Token

Use a refresh token to obtain a new access token.

Request (example)

{
 "refresh_token": "def50200...",
 "client_id": "YOUR_CLIENT_ID",
 "client_secret": "YOUR_CLIENT_SECRET",
 "grant_type": "refresh_token"
}

Response (example)

{
 "access_token": "eyJhbGciOi...NEW",
 "refresh_token": "def50200...MAYBE_NEW",
 "token_type": "Bearer",
 "expires_in": 3600
}

Test Token (Me)

Validate an access token and return information about the current identity/session.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request

{}

Response (example)

{
 "id": "encoded_account_user_id",
 "userid": 123,
 "name": "oauthuser"
}

Available Tables

Returns all available tables for the authenticated account. By default this endpoint returns only table names.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request (table names only)

POST /api/oauth2/tables/zapier

{}

Response (table names only)

{
 "tables": ["accounts", "contacts", "opportunity_products"],
 "total_count": 3
}

Request (with fields)

POST /api/oauth2/tables/zapier?showFields=true

{}

Response (with fields, shortened example)

 { "tables": [ { "name": "opportunity_products",
 "fields": [
 { "name": "id", "orgName": "id", "table": "opportunity_products", "format": "id" },
 { "name": "name", "orgName": "name", "table": "opportunity_products", "format": "name" } ] } ],
 "total_count": 1 }

Get Records (by IDs)

Provide an array of record IDs and receive the full records.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request Body Parameters

The request body should be an array of record IDs (numbers). You can also pass objects with an id property, or a mix of both.

Query Parameters

Request (example - array of IDs)

[101, 102, 205]

Request (example - array of objects)

[{"id": 101}, {"id": 102}, {"id": 205}]

Request with limit query parameter

POST /api/oauth2/getRecords/zapier/contacts?limit=100

[101, 102, 205]

Response (example)

[
 { 
 "id": 101, 
 "name": "Acme Ltd",
 "created_by": 5,
 "created_date": "2025-01-15T10:30:00Z",
 "last_modified_by": 5,
 "last_modified_date": "2025-01-20T14:22:00Z"
 },
 { 
 "id": 102, 
 "name": "Globex",
 "created_by": 3,
 "created_date": "2025-01-10T09:15:00Z",
 "last_modified_by": 7,
 "last_modified_date": "2025-01-18T16:45:00Z"
 }
]

Find Records (filter / fields / sort / paging)

A powerful flexible querying endpoint supporting: selecting specific fields, filtering with advanced operators, text search, multi-field sorting, and pagination.

Request Body

Query Parameters

Example 1: Simple equality filter with search

{
 "fields": ["id", "name", "email", "phone"],
 "filter": {
 "search": "john"
 },
 "sort": [
 { "field": "name", "direction": "ASC" }
 ],
 "page_size": 25,
 "page": 1
}

Example 2: Multiple equality conditions

{
 "filter": {
 "where": {
 "status": "Open",
 "assigned_to": 17
 }
 },
 "sort": [
 { "field": "updated_at", "direction": "DESC" }
 ],
 "page_size": 50,
 "page": 2
}

Example 3: Using comparison operators

{
 "fields": ["id", "name", "amount", "deal_date"],
 "filter": {
 "where": {
 "amount": {
 "operator": ">=",
 "value": 10000
 },
 "deal_date": {
 "operator": ">",
 "value": "2025-01-01"
 }
 }
 },
 "sort": [
 { "field": "amount", "direction": "DESC" }
 ],
 "page_size": 100
}

Example 4: Using IN operator for multiple values

{
 "fields": ["id", "name", "status", "priority"],
 "filter": {
 "where": {
 "status": {
 "operator": "IN",
 "value": ["Open", "In Progress", "Pending"]
 },
 "priority": {
 "operator": "!=",
 "value": "Low"
 }
 }
 },
 "sort": [
 { "field": "priority", "direction": "ASC" },
 { "field": "created_date", "direction": "DESC" }
 ]
}

Example 5: Using LIKE operator for pattern matching

{
 "fields": ["id", "name", "email"],
 "filter": {
 "where": {
 "email": {
 "operator": "LIKE",
 "value": "%@company.com"
 }
 }
 },
 "page_size": 50
}

Example 6: Common fields filter with NOT IN

{
 "fields": ["id", "name", "created_by", "created_date", "last_modified_date"],
 "filter": {
 "where": {
 "created_by": {
 "operator": "NOT IN",
 "value": [1, 2, 3]
 }
 }
 },
 "sort": [
 { "field": "last_modified_date", "direction": "DESC" }
 ],
 "page_size": 20,
 "page": 1
}

Response (example)

[
 { 
 "id": 501, 
 "name": "Contact Name",
 "created_by": 5,
 "created_date": "2025-01-15T10:30:00Z",
 "last_modified_date": "2025-01-21T09:15:00Z"
 },
 { 
 "id": 498, 
 "name": "Another Contact",
 "created_by": 5,
 "created_date": "2025-01-12T14:20:00Z",
 "last_modified_date": "2025-01-20T16:45:00Z"
 }
]

Create Records

Create one or more records in the specified table.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request Body

The request body must be an array of record objects to create.

Request (example)

[
 { "name": "New Account", "phone": "+1-555-0100" },
 { "name": "Another Account", "phone": "+1-555-0200" }
]

Response (example)

{
 "id": 901,
 "affectedRows": 2,
 "insertId": 901
}

Update Records

Update one or more records by ID.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request Body

The request body must be an array of record objects to update. Each object must include an id field.

Request (example)

[
 { "id": 101, "phone": "+1-555-9999", "status": "Active" },
 { "id": 102, "status": "Inactive" }
]

Response (example)

{
 "id": 0,
 "affectedRows": 2,
 "changedRows": 2
}

Delete Records

Delete one or more records by ID.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request Body

The request body must be an array of objects with id fields to delete.

Request (example)

[
 {"id": 101},
 {"id": 102}
]

Response (example)

{
 "id": 0,
 "affectedRows": 2
}

Send Email

Send messages/sms/emails using templates and settings. Supports bulk email sending with recipient list, optional email templates, and sender configuration.

Headers

Authorization: Bearer <access_token>
Content-Type: application/json

Request Body

Request (example - with template ID)

{
 "templateid": 5,
 "fromEmailSet": 2,
 "rows": [
 { "email": "contact1@example.com", "name": "John Doe" },
 { "email": "contact2@example.com", "name": "Jane Smith" }
 ]
}

Request (example - with inline template)

{
 "fromEmailSet": 1,
 "rows": [
 { "email": "recipient@example.com", "name": "Recipient Name" }
 ],
 "template": {
 "name": "Welcome Email",
 "body": "<h1>Welcome!</h1><p>Thank you for signing up.</p>"
 },
 "task": {
 "name": "Welcome Email Campaign"
 }
}

Response (example)

{
 "affectedRows": 1
}

Errors & Notes

Common HTTP statuses

Example cURL - Find Records

curl -X POST "https://app.brosh.io/api/oauth2/findRecords/zapier/contacts" \
 -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
 "fields":["id","name","email","created_date","last_modified_date"],
 "filter":{"search":"john"},
 "sort":[{"field":"last_modified_date","direction":"DESC"}],
 "page_size":25,
 "page":1
 }'

Example cURL - Get Records with Limit

curl -X POST "https://app.brosh.io/api/oauth2/getRecords/zapier/contacts?limit=100" \
 -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '[101,102,205]'