groups

List

Returns a list of Group objects.

get/knowledgebase/v1/groups

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/v1/groups
  • Auth: HTTP bearer

Query parameters

created_afterstring date-time

If provided, will only return objects created after this datetime.

created_beforestring date-time

If provided, will only return objects created before this datetime.

cursorstring

The pagination cursor value.

expand'parent_group' | 'users' | 'users,parent_group'

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_databoolean

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

include_remote_databoolean

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databoolean

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterstring date-time

If provided, only objects synced by Merge after this date time will be returned.

modified_beforestring date-time

If provided, only objects synced by Merge before this date time will be returned.

page_sizeinteger

Number of results to return per page. The maximum limit is 100.

remote_idstring

The API provider's ID for the given object.

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

nextstring nullable
previousstring nullable

Changes

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