Agents Resource

Gets agent information about a particular person.

getAgent

Gets all agents used by a single person.

Example

const agent: Agent = {
  objectType: "Agent",
  name: "Test Agent",
  mbox: "mailto:[email protected]"
};

xapi.getAgent({
  agent: agent
}).then((result: AxiosResponse<Person>) => {
  const person: Person = result.data;
  // do stuff with person
});

Parameters

Parameter	Type	Required	Description
agent	Agent	true	The agent experiencing the AU.
useCacheBuster	boolean	false	Enables cache busting.

Returns

This method returns an AxiosPromise with the success data containing the Person if successful.