Get Actors

This API provides the capability to retrieve actors in a paginated format. It supports filtering options, allowing precise control over the dataset returned. This is particularly useful when dealing with large datasets where only specific actors need to be retrieved based on role, modification date, or other attributes.

Retrieve a List of Actors

Method: POST
URL: {host_url}/api/actors/actor/GetActorsPage

Minimal Request

{ 
   "sortInfo":[
   ],
   "propertiesToLoad": <write flags value>,
   "offset":0,
   "count":page_size,
   "includeOverallEntryCount":true
}

Parameters

• propertiesToLoad: Flag enumeration used to determine which properties to load (same options as in GetActor call).
• offset: The starting point for retrieving actors.
• count: The number of actors to retrieve per page.
• includeOverallEntryCount: Boolean flag to include the total count of entries.

Optional Filters

• RoleSystemName: Filter actors by specific roles.
• SearchPattern: Search for actors using name, phone number, email, or customer identifier.
• ModifiedAtFrom: Retrieve actors modified after a specific timestamp.
• ModifiedAtTo: Retrieve actors modified before a specific timestamp.
• ActorIds: Filter actors by their IDs.

Retrieve Actor Information

This API retrieves detailed actor information in a paginated format.

Method: POST
URL: {host_url}/api/actors/actor/GetActorInfoPage

Minimal Request

{ 
   "offset": 0,
   "count": page_size,
   "includeOverallEntryCount":true
}

Optional Filters

• RoleSystemNames: Filter actors by specific roles.
• ActorIds: Retrieve actors based on their IDs.

tip

This API is useful when additional actor-related metadata is needed beyond the standard actor retrieval request.