List people with the Agendor API

Lists and searches the people of the account, 10 per page by default, in data, with meta.totalCount and the next page in links.next. Text filters match the beginning of the value.

Identifier
agendor_list_people

The request

POST https://connect.reportei.com/api/tools/agendor_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
namestringNoBeginning of the name.
emailstringNoBeginning of the email address.
cpfstringNoBeginning of the CPF.
phonestringNoNumber searched in every phone field.
organizationintegerNoId of an organization, from List organizations, to return its people.
userOwnerintegerNoId of the user who owns the people, from List users.
statestringNoState abbreviation of the address.Values: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
createdAtGtstringNoReturns people created after this date and time, in ISO 8601.
updatedAtGtstringNoReturns people updated after this date and time, in ISO 8601.
withCustomFieldsbooleanNotrue includes the custom fields of each person.
pageintegerNoPage number, starting at 1.
per_pageintegerNoPeople per page, up to 100. The default is 10.

Supported connections

Your customer connects their Agendor account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/agendor_list_people. It becomes your agent's tool definition with no conversion.

Other Agendor tools

See all 15 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.