GET
/
contact
curl --request GET \
  --url https://api.fint.app/api/v1/contact \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "data": [
        {
          "id": 123,
          "name": "<string>",
          "lastName": "<string>",
          "createdAt": "<string>",
          "documentType": "DNI",
          "documentNumber": "<string>",
          "address": "<string>",
          "country": "<string>",
          "birthDate": "<string>",
          "age": 123,
          "phoneNumber": "<string>",
          "mobileNumber": "<string>",
          "email": "jsmith@example.com",
          "hasSiblings": true,
          "tags": [
            {
              "id": 123,
              "name": "<string>",
              "color": "<string>",
              "icon": "<string>",
              "group": true,
              "parent": {
                "id": 123,
                "name": "<string>",
                "color": "<string>",
                "icon": "<string>"
              }
            }
          ],
          "active": true,
          "activeStatus": {
            "id": 123,
            "name": "<string>",
            "active": true
          },
          "status": "ACCOUNT_OPENED",
          "items": [
            123
          ],
          "hash": "<string>"
        }
      ],
      "total": 123,
      "totalPages": 123,
      "currentPage": 123,
      "limit": 123,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
search
string
​
page
number | null
default:0
​
limit
number
default:10
Required range: x > 0
​
document
string
​
tagIds
number[] | null
​
includeAllTags
boolean | null
​
includeAllItems
boolean | null
​
active
boolean | null
​
itemIds
number[] | null
​
statuses
enum<string>[] | null
Available options:
ACCOUNT_OPENED,
NOT_DUE,
PAST_DUE,
ACCOUNT_SETTLED
​
startDate
string | null
​
endDate
string | null

Response

200 - application/json
Contactos recuperados con éxito
​
data
object[]
required