List of customers

GET 
/companies/:company_id/customers

List of customers

Request

Query Parameters

offset number

Default value: 0

limit number

Possible values: >= 1

Default value: 10

creation_from string
creation_to string
updated_from string
updated_to string

Responses

200

success - paginated list of customers

application/json

Schema

Schema

• Array [

id stringrequired
name stringrequired
created stringrequired

The date of creation of the customer

updated stringrequired

The date of the last update of the customer

general

object

nullable

entryDateIntoRelationship stringnullable

originCustomerRelationship string

contactCustomerRelationship string

remoteOpening boolean

gender string

Default value: male

name string

birthName string

surname string

birthDate stringnullable

birthCity string

birthZipCode string

deathDate stringnullable

familySituation string

nationality string

matrimonialRegime string

studiesLevel string

occupation string

occupationWording string

retirementAge number

annualIncome string

heritageOrigin string

seniorAdvisor string

secondaryAdvisor string

dateEntryRelationship stringnullable

idCard string

idNumber string

issueDate stringnullable

authority string

expirationDate stringnullable

idNIF string

idMIF string

taxResidence string

customerClassificationMIF string

classificationDate stringnullable

pep boolean

usPerson string

legalCapacity string

details

object

nullable

street string

zipCode string

city string

workStreet string

workZipCode string

workCity string

otherStreet string

otherZipCode string

otherCity string

firstPhoneNumber string

secondPhoneNumber string

personalEmail string

otherEmail string

fiscalAddress string

country string

otherCountry string

workCountry string

• ]

Example (from schema)

[
  {
    "id": "adfdfaca-48f0-4f3b-b30a-c6d97293090c",
    "name": "Jean dupont",
    "created": "2024-01-01T00:00:00.000Z",
    "updated": "2024-01-01T00:00:00.000Z",
    "general": {
      "entryDateIntoRelationship": "string",
      "originCustomerRelationship": "string",
      "contactCustomerRelationship": "string",
      "remoteOpening": true,
      "gender": "male",
      "name": "string",
      "birthName": "string",
      "surname": "string",
      "birthDate": "string",
      "birthCity": "string",
      "birthZipCode": "string",
      "deathDate": "string",
      "familySituation": "string",
      "nationality": "string",
      "matrimonialRegime": "string",
      "studiesLevel": "string",
      "occupation": "string",
      "occupationWording": "string",
      "retirementAge": 0,
      "annualIncome": "string",
      "heritageOrigin": "string",
      "seniorAdvisor": "string",
      "secondaryAdvisor": "string",
      "dateEntryRelationship": "string",
      "idCard": "string",
      "idNumber": "string",
      "issueDate": "string",
      "authority": "string",
      "expirationDate": "string",
      "idNIF": "string",
      "idMIF": "string",
      "taxResidence": "string",
      "customerClassificationMIF": "string",
      "classificationDate": "string",
      "pep": true,
      "usPerson": "string",
      "legalCapacity": "string"
    },
    "details": {
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "workStreet": "string",
      "workZipCode": "string",
      "workCity": "string",
      "otherStreet": "string",
      "otherZipCode": "string",
      "otherCity": "string",
      "firstPhoneNumber": "string",
      "secondPhoneNumber": "string",
      "personalEmail": "string",
      "otherEmail": "string",
      "fiscalAddress": "string",
      "country": "string",
      "otherCountry": "string",
      "workCountry": "string"
    }
  }
]

Loading...