PHphantombuster
agents

GET /agents/fetch-all

Gets all agents of the current user's organization.

Request

Query parameters

string[]
OR
string

If set, the agents will be filtered by the provided input types. An input type represents a resource the agent is expected to consume (i.e. "profileUrl", "companyUrl" etc...). You may find them in the response of the endpoint /agents/fetch with manifest

string[]
OR
string

If set, the agents will be filtered by the provided output types. An output type represents a resource the agent is expected to produce (i.e. "fullName", "job", "company" etc...). You may find them in the response of the endpoint /agents/fetch with manifest

string[]
OR
string

If set, only the agents with the provided IDs will be returned. Can be a single ID or an array of IDs

withAgentSlotsFactorstring

Set to "true" if you want to include the agent's reservedAgentSlotsFactor from the script branch configuration in the response

withArgumentstring

Set to "true" if you want to include the agent's argument in the response

Headers

X-Phantombuster-Orgstring

ID of the org that is perfoming the operation (not necessary when using a third party key)

Response

OK

idstring required
namestring nullable
createdAtnumber required
scriptOrgNamestring nullable
scriptIdstring nullable
scriptstring nullable
branchstring nullable
environment'staging' | 'release' nullable
argumentstring nullable
lastEndType'finished' | 'killed' | 'global timeout' | 'org timeout' | 'agent timeout' | 'unknown' | 'no log timeout' nullable
lastEndedAtnumber nullable
lastExitCodenumber nullable
nbContainersRunningnumber required
runningTimenumber nullable
launchType'manually' | 'repeatedly' | 'once' | 'after agent'
lastNonManualLaunchType'manually' | 'repeatedly' | 'once' | 'after agent' nullable
s3Folderstring
slaveSlugstring nullable
masterAgentIdstring nullable
launchBeforenumber nullable
launchOnceAtnumber nullable
launchAfterAgentIdstring nullable
masterAgentLaunchAfternumber nullable
reservedAgentSlotsFactornumber
wasSetupValidWhenSubmittedByTheFrontendboolean
expireAtnumber nullable
internalMetadataobject nullable
userCustomMetadataobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.