public

Lister les contacts du cabinet

GET

/v1/contacts

curl --request GET \
  --url '/v1/contacts?search=%3Cstring%3E&kind=physique&country=%3Cstring%3E&vatRegime=standard&tagId=%3Cstring%3E&city=%3Cstring%3E&doNotRemind=true&billingStatus=ready&sort=name&dir=asc&page=1&pageSize=15' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "addressLine": "<string>",
      "assujettiTva": "inconnu",
      "city": "<string>",
      "civility": "<string>",
      "companyRoles": [],
      "country": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "doNotRemind": true,
      "email": "jsmith@example.com",
      "firstName": "<string>",
      "groupSubtype": null,
      "id": "<string>",
      "kind": "physique",
      "lastName": "<string>",
      "legalForm": "<string>",
      "legalName": "<string>",
      "parentCompanyId": "<string>",
      "parentCompanyName": "<string>",
      "phone": "<string>",
      "postalCode": "<string>",
      "siren": "<string>",
      "tags": [],
      "vatNumber": "<string>",
      "vatRegime": "standard",
      "vatTerritory": "metropole_corse",
      "vatValid": null
    }
  ],
  "page": 123,
  "pageSize": 123,
  "total": 123
}

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

searchstringquery

Maximum string length: 200

kindenum<string>[]query

countrystring[]query

vatRegimeenum<string>[]query

tagIdstring[]query

citystring[]query

doNotRemindbooleanqueryobligatoire

billingStatusenum<string>query

Options disponibles: ready, incomplete

sortenum<string>query

Options disponibles: name, type, email, city, vatRegime, country, legalForm, createdAt

direnum<string>querydefault:asc

Options disponibles: asc, desc

pageintegerquerydefault:1

Plage requise: 1 <= x

pageSizeintegerquerydefault:15

Plage requise: 1 <= x <= 100

Réponse

itemsobject[]obligatoire

Afficher child attributes

pageintegerobligatoire

Plage requise: 0 < x

pageSizeintegerobligatoire

Plage requise: 0 < x

totalintegerobligatoire

Plage requise: 0 <= x

Besoin d'aide supplémentaire ? Demander à l'équipe