Records

List records in a module

Returns a paginated list of records. Requires the records:read scope.

get/modules/{moduleSlug}/records

Request

  • Base URL: https://api.getcoherence.io/v1
  • URL: https://api.getcoherence.io/v1/modules/{moduleSlug}/records
  • Auth: HTTP bearer

Query parameters

pageinteger
pageSizeinteger

Results per page (max 100)

searchstring

Free-text query within the module

sortFieldstring
sortDirection'asc' | 'desc'
filterobject

Simple field filters, e.g. filter[status]=active,pending (comma = OR).

advancedFilterstring

JSON-encoded advanced filter (operators + AND/OR grouping).

labelIdsstring

Comma-separated label IDs

typeIdsstring

Comma-separated type IDs

fieldsstring

Comma-separated field slugs to include in each record's fields

Response

Paginated record list

pageinteger
pageSizeinteger
totalinteger

Example response

{
  "records": [
    {
      "moduleSlug": "contacts"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.