public

Récupérer un contact par son identifiant

GET

/v1/contacts/{id}

curl --request GET \
  --url '/v1/contacts/{id}' \
  --header 'Authorization: Bearer <token>'

{
  "addressLine": "<string>",
  "assujettiTva": "inconnu",
  "birthCity": null,
  "birthCountry": null,
  "channels": [],
  "city": "<string>",
  "civility": "<string>",
  "companyData": {},
  "country": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dateOfBirth": null,
  "deletedAt": "2023-11-07T05:31:56Z",
  "doNotRemind": true,
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "function": "<string>",
  "groupSubtype": null,
  "id": "<string>",
  "isAutoEntrepreneur": false,
  "kind": "physique",
  "lastName": "<string>",
  "legalForm": "<string>",
  "legalName": "<string>",
  "linkedCompanies": [
    {
      "id": "<string>",
      "kind": "morale",
      "name": "<string>",
      "role": null
    }
  ],
  "members": [],
  "mentions": "<string>",
  "pappersPendingChanges": [
    {
      "after": "<string>",
      "annonce": {
        "complement": "<string>",
        "nature": "<string>",
        "tribunal": "<string>"
      },
      "before": "<string>",
      "field": "<string>",
      "id": "<string>",
      "sourceUrl": "<string>"
    }
  ],
  "pappersSyncedAt": "2023-11-07T05:31:56Z",
  "parentCompanyId": "<string>",
  "parentCompanyName": "<string>",
  "phone": "<string>",
  "postalCode": "<string>",
  "reference": "<string>",
  "siren": "<string>",
  "siret": "<string>",
  "tags": [],
  "tenantId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "vatNumber": "<string>",
  "vatRegime": "standard",
  "vatTerritory": "metropole_corse",
  "vatValid": null,
  "viesCheckedAt": null
}

Autorisations

Authorizationstringheaderobligatoire

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

Paramètres de chemin

idstringobligatoire

Réponse

addressLinestring | nullobligatoire

assujettiTvaenum<string>default:inconnu

Options disponibles: assujetti, non_assujetti, inconnu

birthCitystring | nulldefault:null

birthCountrystring | nulldefault:null

channelsobject[]default:[]

Afficher child attributes

citystring | nullobligatoire

civilitystring | nullobligatoire

companyDataobject | nullobligatoire

countrystring | nullobligatoire

createdAtstringobligatoire

createdBystring | nullobligatoire

dateOfBirthstring | nulldefault:null

Motif: ^\d{4}-\d{2}-\d{2}$

deletedAtstring | nullobligatoire

doNotRemindbooleanobligatoire

emailstring | nullobligatoire

firstNamestring | nullobligatoire

functionstring | nullobligatoire

groupSubtypeenum<string> | nulldefault:null

Options disponibles: indivision, succession, societe_de_fait

idstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

isAutoEntrepreneurbooleandefault:false

kindenum<string>obligatoire

Options disponibles: physique, morale, groupement

lastNamestring | nullobligatoire

legalFormstring | nullobligatoire

Required string length: 1 - 200

legalNamestring | nullobligatoire

linkedCompaniesobject[]obligatoire

Afficher child attributes

membersobject[]default:[]

Afficher child attributes

mentionsstring | nullobligatoire

pappersPendingChangesobject[] | nullobligatoire

Afficher child attributes

pappersSyncedAtstring | nullobligatoire

parentCompanyIdstring | nullobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

parentCompanyNamestring | nullobligatoire

phonestring | nullobligatoire

postalCodestring | nullobligatoire

referencestring | nullobligatoire

sirenstring | nullobligatoire

siretstring | nullobligatoire

tagsobject[]default:[]

Afficher child attributes

tenantIdstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

updatedAtstringobligatoire

vatNumberstring | nullobligatoire

vatRegimeenum<string> | nullobligatoire

Options disponibles: standard, exonere, dom_tom

vatTerritoryenum<string> | nullobligatoire

Options disponibles: metropole_corse, dom_reduit, dom_guyane_mayotte, com_hors_champ

vatValidboolean | nulldefault:null

viesCheckedAtstring | nulldefault:null

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