FlaresendDocs
Contacts

List contacts

Page through the project's contacts, newest first, with an optional search.

GET/v1/contactsAPI key

Returns contacts ordered by creation time, newest first. The list is cursor-paginated: pass the nextCursor from one page as cursor to get the next. See Pagination.

Query parameters

limitnumberquerydefault: 25

How many contacts per page, from 1 to 100. Values outside that range are clamped to it.

cursorstringquery

The nextCursor value from the previous page.

qstringquery

Keep only contacts whose email, first name or last name contains this text.

Response

dataContact[]

The contacts on this page. Each has the fields described in Create a contact.

nextCursorstring | null

Pass this as cursor to get the next page. null on the last page.