Browse the extensions reference

agents

returns [Agent!]!

List counterparty agents with optional filters.

Arguments

NameTypeDescription
agentTypeStringFilter by counterparty role, e.g. customer or vendor.
sourceStringFilter by originating system, e.g. quickbooks.
isActiveBoolean = trueFilter on active status. Defaults to active only; pass null for both.
limitIntMaximum rows to return, 1-1000. Omit to use this field's own default; out of range raises INVALID_PAGINATION.
offsetIntRows to skip before returning, 0 or greater. Out of range raises INVALID_PAGINATION.

Returns Agent

FieldTypeDescription
idString!
agentTypeString!
nameString!
legalNameString
taxIdString
registrationNumberString
dunsString
leiString
emailString
phoneString
addressJSON
sourceString!
externalIdString
isActiveBoolean!
is1099RecipientBoolean!
createdAtDateTime
updatedAtDateTime
createdByString
openReceivableOpenBalanceByAgent
openPayableOpenBalanceByAgent

Example

query
{ agents { id agentType name legalName } }
curl
curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ agents { id agentType name legalName } }"}'