/{connector_id}/list_updated_accounts

Retrieve accounts that have been updated since a specified point in time.

This operation enables efficient account synchronization by allowing clients to fetch only accounts that have been modified since their last sync. This is particularly useful for maintaining up-to-date account information across large user bases without having to fetch all accounts on every request.

Use Cases

  • Account Synchronization: Keep local account databases in sync with the remote system's current state
  • Audit Trails: Track account changes for compliance and security purposes
  • Real-time Updates: Monitor account modifications for immediate action
  • Data Migration: Identify accounts that need to be updated during system migrations or upgrades

Delta Query Support

This operation supports delta queries for incremental synchronization:

  • Initial Request: Provide a since to get all accounts updated since that time
  • Subsequent Requests: Use the cursor from the previous response for efficient incremental updates
  • Cursor Management: Each response includes a new cursor for the next request

Account Update Detection

Different connectors may define "updates" differently based on their capabilities:

  • Profile information changes (name, email, department, etc.)
  • Permission or role modifications
  • Account status changes (active/inactive, suspended, etc.)
  • Custom attribute modifications
  • Group membership changes

Rate Limiting Considerations

  • Implement exponential backoff for repeated requests
  • Consider batching requests for large account populations
  • Monitor API rate limits specific to each connector
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Generic request model.

auth
object

Authentication credentials, which can be one of several types.

credentials
array of objects
credentials
request
object
required

Request parameters for listing updated accounts with delta query support.

This model extends the Delta model to provide both traditional date-based filtering and efficient cursor-based incremental synchronization.

Parameter Priority

When both cursor and since are provided:

  • The cursor takes precedence for delta-based synchronization
  • The since is ignored in favor of the cursor's timestamp

Best Practices

  • Use cursor for ongoing synchronization to minimize data transfer
  • Use since for initial syncs or when resuming after a long gap
  • Include only necessary custom_attributes to optimize response size
  • Store the returned cursor persistently for reliable sync state

Error Scenarios

  • Invalid Cursor: May return an error or fall back to full data fetch
  • Expired Cursor: Connector may return all data since the cursor's timestamp
  • Unsupported Attributes: Custom attributes not available in the connector may be ignored or cause errors depending on the connector implementation
boolean

Whether to include raw data in the response.

page
object

Pagination parameters for requests and responses.

settings
object

Connector-specific settings for the request.

These are settings that are shared across all capabilities.

Usually contain additional required configuration options not specified by the capability schema.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json