Lead sources
Lookups API · lookups.lead_sources
URL · Fields · Example · Response · Try it
URL and authentication
POST https://YOUR-BACKEND/api/automation/v1/execute
Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.
This operation requires read access and CRM permission view_contacts. The gateway invokes GET /api/v1/app/lookup/lead-sources internally. Use the POST URL above with your automation key, including for read and delete operations.
Request parameters
| Key | Type | Requirement |
|---|---|---|
operation | string | Required; exactly lookups.lead_sources |
data | object | Optional; see fields below |
Fields
Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.
No data fields are required. Send {} for data, or omit it.
Example request
Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.
{
"operation": "lookups.lead_sources",
"data": {}
}
Response
Returns the permitted lookup values in data. Use the returned identifiers or enum values in your subsequent requests. The value shape depends on the lookup; this tester displays the complete JSON response.
The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.
Errors
| HTTP status | Meaning |
|---|---|
| 400 | A CRM business rule rejected the action. |
| 401 | Missing, invalid, expired or revoked connection key. |
| 403 | Connection access or CRM permissions do not allow this action. |
| 404 | Operation or record unavailable. |
| 413 | Request or result exceeds its size limit; reduce payload or page size. |
| 422 | Missing or invalid fields, or a CRM business rule rejected the operation. |
| 429 | Rate limit exceeded; wait before retrying. |
| 500 | The server could not complete the operation. |
Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.
Try it
Brixit API v1
Try this request
Requests run from your browser to your installation. Enter the backend URL shown in Brixit. Your connection key stays in this component’s memory and is cleared when you leave this page.
curl --request POST 'https://crm.example.com/api/automation/v1/execute' \
--header "Authorization: Bearer $BRIXIT_CONNECTION_KEY" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"operation": "lookups.lead_sources",
"data": {}
}'Code uses a connection-key variable; your entered key is never included in copied examples.