Agency Client Activity

Get a list of Agency Client activities

Retrieve a list of activity for agency client

get/agency/{agency_id}/client/{client_id}/activity

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency/{agency_id}/client/{client_id}/activity
  • Auth
    HTTP basic and HTTP basic and HTTP basic

Query parameters

pageinteger

The page number

items_per_pageinteger

No of records per page

sortBystring[]

A comma separated list of fields indicating sort order activity_type, a negative sign reverses direction -activity_type

activity_typestring[]

Filter the type of activities that is returned

activity_date_at_fromstring date-time

Activity from date

activity_date_at_tostring date-time

Activity to date

created_by_userstring

Filter activities based on the ID of user that created the activity

created_by_user_namestring

Filter activities based on the name of the user that created the activity

linked_entity_idstring

Filter activities based on entity id of linked entities

linked_entity_typestring

Filter activities based on entity id of linked entities

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Response

The agency client activities will be returned

activity_typestring required
descriptionstring
subject_candidate_namestring

This is a deprecated property, any value passed on this property will be ignored and will be removed in the future

created_by_userstring

This is a deprecated property, any value passed on this property will be ignored and will be removed in the future

created_by_user_namestring

This is a deprecated property, any value passed on this property will be ignored and will be removed in the future

commentstring
_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
activity_datestring date-time required
created_by_context_idstring
created_by_context_typestring

Example response

[
  {
    "activity_type": "REGISTRATION_CALL_MADE"
  }
]

Changes

No recorded changes to this operation across all 3 revisions of this API.