Skip to main content

August 2026 API Updates

Read more about all our API updates in Q3

Written by Crelate Support

Forms API Improvements

  • GET /forms/templates/{id}/layout

    • Capabilities

      • Returns the full field layout of a form template, resolved from the org’s form definition cache.

      • Includes inactive definitions, so historical or draft templates can still be rendered; returns a friendly not-found when no template matches.

    • Example use cases

      • Render a Crelate form natively inside an external candidate or client portal.

      • Build a preview of a form template before sending a request.

  • GET /formfields/info · /formresponses/info

    • Capabilities

      • Customer-level “info” metadata endpoints exposing the field/schema definitions for form fields and form responses (the underlying entities are otherwise internal).

      • Returns the structural definition you need to interpret form data programmatically

    • Example use cases

      • Map Crelate form fields to columns in a downstream data warehouse.

      • Validate or label form-response payloads in an integration before processing.

Relationships Retrieval API

User-friendly, read-oriented access to the relationship graph between records, with group and type codes resolved to human-readable names.

  • GET /relationships

    • Capabilities

      • Filters by parent_id, target_id, group_code and type_code, composed safely server-side (no raw query grammar exposed).

      • Paged with offset/limit (capped at the platform max) and a whitelisted sort_by (ModifiedOn, CreatedOn, group or type) to prevent arbitrary sort injection.

      • Returns a collection with TotalCount and MoreRecords, with group/type codes resolved to friendly names.

      • Enforces both feature entitlement and per-user read permission on relationships.

    • Example use cases

      • Build an org chart or referral-network view for an account in an external app.

      • Export a contact’s relationships for analytics or reporting.

  • GET /relationships/{relationshipId}

    • Capabilities

      • Retrieves a single relationship by id, with group and type names resolved; returns not-found on an unknown id.

    • Example use cases

      • Drill into a specific connection surfaced elsewhere in a UI.

      • Confirm a relationship’s type after a write operation.

  • GET /relationships/definitions.

    • Capabilities

      • Returns the relationship groups and types configured for the org (codes + names), ordered by name

    • Example use cases

      • Populate filter dropdowns before calling GET /relationships.

      • Translate group/type codes in stored data back to labels.

Webhooks CRUD

First-class API management of V3 webhooks, so integrations can subscribe to record changes without a Crelate admin in the loop.

  • GET /webhooks · /webhooks/{id}

    • Capabilities

      • List (paged) and single-record retrieval returning a focused field set: id, created/modified timestamps, URL, name, status, target entity type and operation type.

    • Example use cases

      • Build a webhook-management screen in an integration’s admin UI.

      • Audit which events an integration is currently subscribed to.

  • POST /webhooks

    • Capabilities

      • Creates a webhook from name, url, status (1 = Activated, 0 = Deactivated), operationName (Create / Update / Delete) and entityName (Contacts / Jobs / Companies).

      • Validates the operation and entity names up front and defaults new webhooks to V3; returns the new record’s id.

      • (Activate/deactivate toggles exist but remain Crelate-internal, not customer-exposed.)

    • Example use cases

      • Register a “new contact created” subscription that pushes to an external CRM.

      • Wire a “job updated” notification into a Slack or messaging integration.

Did this answer your question?