GET | List all LDAP group syncs

Description

List the LDAP group synchronizations registered in the Segura™ platform. Each item is a summary. To read every setting of one synchronization, access GET | List an LDAP group sync by [id].

Prerequisites

An application with the Users authorization granted by the administrator in A2A. For more information, access How to manage authorizations in A2A.
A valid OAuth 2.0 access token. For more information, access How to authenticate an application in A2A.

Request

GET /api/v2/iam/ldap-group-syncs

Query parameters

Filters address the canonical model, so each field carries its object prefix. Sending a filter without the prefix returns 400.

Field	Type	Required	Description
`group_sync.name`	string	No	Exact match on the synchronization name.
`group_sync.active`	boolean	No	Filters by the active state. Accepts `true` or `false`.
`group_sync.server_id`	int	No	Filters by the LDAP server.
`group_sync.user_group_id`	int	No	Filters by the user group.
`group_sync.synchronization_enabled`	boolean	No	Filters by whether the synchronization runs.
`group_sync.automatic_sync`	boolean	No	Filters by whether the platform runs the synchronization on its own schedule.
`group_sync.last_sync_succeeded`	boolean	No	Filters by the outcome of the last run.
`domum.enabled`	boolean	No	Filters by whether the Domum block is enabled.
`search`	string	No	Substring match across `name`, `dn`, and `ad_query`.
`sort_by`	string	No	Comma-separated `field:asc` or `field:desc` segments. Sortable fields: `id`, `group_sync.name`, `group_sync.active`, `group_sync.last_sync_at`, `group_sync.created_at`, `group_sync.updated_at`. Default: `group_sync.name:asc`.
`fields`	string	No	Comma-separated canonical paths that limit the fields returned.
`page`	int	No	Page of the result set. Default: `1`.
`limit`	int	No	Maximum number of results per page. Default: `50`.

Attention

The prefix is mandatory. ?group_sync.active=true returns the filtered list, while ?active=true returns 400. The same applies to sorting: sort_by=group_sync.name:asc is valid and sort_by=name:asc returns 422 api.enum.invalid_value.

Example request `GET` `{{url}}/api/v2/iam/ldap-group-syncs?group_sync.active=true&sort_by=group_sync.name:asc&page=1&limit=50`

Response

HTTP/1.1 200 OK

Each item in data is a flat summary. The nested group_sync and domum objects appear only in the detail response.

Example response body

{
    "data": [
        {
            "id": "501",
            "name": "Infrastructure operators",
            "active": true,
            "server_id": "10",
            "user_group_id": "7",
            "synchronization_enabled": true,
            "automatic_sync": false,
            "last_sync_at": "2026-06-02T14:21:08-03:00",
            "last_sync_succeeded": true,
            "domum_enabled": true
        },
        {
            "id": "502",
            "name": "Finance auditors",
            "active": false,
            "server_id": "10",
            "user_group_id": "12",
            "synchronization_enabled": false,
            "automatic_sync": false,
            "last_sync_at": null,
            "last_sync_succeeded": null,
            "domum_enabled": false
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 50,
            "total_items": 2,
            "total_pages": 1
        }
    }
}

Response body fields

Field	Type	Description
`data`	array of objects	The synchronizations matching the request.
`meta`	object	Pagination metadata.

`data`

Field	Type	Description
→`id`	string	Unique identification code of the synchronization, assigned by Segura™.
→`name`	string	Name of the synchronization.
→`active`	boolean	Indicates whether the synchronization is active.
→`server_id`	string	Identification code of the LDAP server.
→`user_group_id`	string	Identification code of the user group. Returns `null` when no group is bound.
→`synchronization_enabled`	boolean	Indicates whether the synchronization runs.
→`automatic_sync`	boolean	Indicates whether the platform runs the synchronization on its own schedule.
→`last_sync_at`	string	Date and time of the last run in ISO 8601 format. Example: `2026-06-02T14:21:08-03:00`. Returns `null` when the synchronization has never run.
→`last_sync_succeeded`	boolean	Outcome of the last run. Returns `null` when the synchronization has never run.
→`domum_enabled`	boolean	Indicates whether the Domum block is enabled.

`meta.pagination`

Field	Type	Description
→→`page`	int	Current page.
→→`limit`	int	Maximum number of results per page.
→→`total_items`	int	Total number of synchronizations matching the filters.
→→`total_pages`	int	Total number of pages.

Errors

HTTP code	Message	Possible cause	Solution
`400`	`api.request.malformed`	A filter was sent without its canonical prefix.	Prefix the field with `group_sync.` or `domum.`.
`403`	`api.permission.denied`	The application lacks permission for this resource.	Ask the administrator to check the application's Users authorization in A2A.
`422`	`api.enum.invalid_value`	`sort_by` names a field that is not sortable, or omits the canonical prefix.	Send one of the sortable fields listed in the query parameter table.
`422`	`api.validation.invalid_field`	`fields` contains a path that is not part of the canonical model.	Check the field paths and resend the request.
`429`	`rate_limit_exceeded`	The application exceeded its request quota.	Wait for the period in the `Retry-After` header and resend the request.

Authentication errors

Message	Possible cause	Solution
`Client authentication failed.`	Application authentication failure with the Segura server.	Check the authentication parameters (`Access Token URL`, `Client ID`, and `Client secret`) and request a new access token.
`Invalid signature`	Failure in recognizing the client application URL.	Check the URL of the client application and resend the request.
`No route matched with those values.`	Missing authorization header in the API request.	Request a new access token.
`Request timed out.`	The request exceeded the timeout limit.	Check the connectivity between the source of the request and the Segura server.