List contacts

GET /v1/contacts

The people in your phonebook, newest first. phone finds one person by their number; project_id keeps to one project. A test key lists none. Needs contacts:read.

Parameters

Name	In	Type	Required	Description
`project_id`	query	string (uuid) or null	No	Only this project's.
`phone`	query	string or null	No	Only the person with this number.
`limit`	query	integer	No	How many to return, 1 to 100.
`cursor`	query	string or null	No	`next_cursor` from the previous page, with the same filters.

Answer

200 with ContactList.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
`422`	Validation Error
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

Find someone in the phonebook by their number

#!/bin/sh
# Find someone in the phonebook by their number
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/contacts?phone=+12025550131" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.