TRtrusspayments
Integration: Contacts
Contacts

List contacts

Allows filtering contacts using OR logic instead of the default AND, enabling matches on any of the specified criteria.

Required Scopes:

contacts:read

get/v1/contacts/

Request

  • Base URL
    https://api.foundation.dev.trusspayments.com
  • URL
    https://api.foundation.dev.trusspayments.com/v1/contacts/
  • Auth
    HTTP bearer

Query parameters

emailstring

Filter by contact email (partial match)

limitinteger

Number of results to return per page.

namestring

Filter by contact name (partial match)

offsetinteger

The initial index from which to return the results.

phonestring

Filter by phone number (partial match)

secondary_emailstring

Filter by secondary email (partial match)

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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