List team members

GET 
/companies/:companyID/teams/:teamName/members

List team members

Request

Path Parameters

teamName stringrequired

Query Parameters

offset number

Default value: 0

limit number

Possible values: >= 1

Default value: 10

Responses

200

Retrieve the list of team members

application/json

Schema

Schema

• Array [

id stringrequired
name stringrequired
email stringrequired

providers

object

nullable

Provider IDs associated with the entity. This field contains a mapping where each key represents a provider name and the value is an array of provider-specific IDs for this entity

prisme

object

nullable

id stringnullable

profile stringnullable

specific

object

nullable

Value specific to the manager with arbitrary structure

nullable

informations

object

personType stringrequired

Possible values: [physical, legal]

civility stringnullable

Possible values: [mr, mrs]

lastName stringnullable

Mandatory if 'personType' is 'physical'.

firstName stringnullable

Mandatory if 'personType' is 'physical'.

birthDate stringnullable

Birth date of the manager

birthTown stringnullable

birthCountry stringnullable

nationality stringnullable

idNumber stringnullable

Identity document number

idDeliveryDate stringnullable

Identity document delivery date

idExpirationDate stringnullable

Identity document expiration date

deathDate stringnullable

Death date of the manager

legalSocialReason stringnullable

Mandatory if 'personType' is 'legal'.

legalSiren stringnullable

legalSiret stringnullable

legalApeCode stringnullable

legalRegistrationCity stringnullable

legalRegistrationCountry stringnullable

legalRegistrationCreationDate stringnullable

legalRegistrationCessationDate stringnullable

legalExecutives

object[]

nullable

Possible values: <= 4

List of legal executives (max 4).

Array [

firstName stringrequired

lastName stringrequired

function stringrequired

]

addresses

object[]

nullable

Possible values: <= 3

List of addresses (max 3).

Array [

type stringnullable

Possible values: [domicile, professional, fiscal]

street stringnullable

supplement stringnullable

city stringnullable

postalCode stringnullable

country stringnullable

]

phones

object[]

nullable

Possible values: <= 3

List of phone numbers (max 3).

Array [

type stringnullable

Possible values: [landline, mobile]

countryCode stringnullable

number stringnullable

]

createdAt stringnullablerequired

Creation date

updatedAt stringnullablerequired

Last update date

leader booleanrequired

• ]

Example (from schema)

[
  {
    "id": "adfdfaca-48f0-4f3b-b30a-c6d97293090c",
    "name": "Jean dupont",
    "email": "jean.dupont@company.tld",
    "providers": {
      "prisme": {
        "id": "id1",
        "profile": "provider1"
      }
    },
    "specific": {},
    "informations": {
      "personType": "physical",
      "civility": "mr",
      "lastName": "Dupont",
      "firstName": "Jean",
      "birthDate": "string",
      "birthTown": "Paris",
      "birthCountry": "FR",
      "nationality": "French",
      "idNumber": "string",
      "idDeliveryDate": "string",
      "idExpirationDate": "string",
      "deathDate": "string",
      "legalSocialReason": "Acme SAS",
      "legalSiren": "123456789",
      "legalSiret": "12345678900012",
      "legalApeCode": "6630Z",
      "legalRegistrationCity": "Paris",
      "legalRegistrationCountry": "FR",
      "legalRegistrationCreationDate": "1994-10-29",
      "legalRegistrationCessationDate": "2024-02-11",
      "legalExecutives": [
        {
          "firstName": "Jeanne",
          "lastName": "Doe",
          "function": "PDG"
        },
        {
          "firstName": "Jacques",
          "lastName": "Dupont",
          "function": "Directeur Général"
        }
      ],
      "addresses": [
        {
          "type": "professional",
          "street": "1 rue de la Paix",
          "supplement": "Bâtiment B",
          "city": "Paris",
          "postalCode": "75001",
          "country": "FR"
        }
      ],
      "phones": [
        {
          "type": "mobile",
          "countryCode": "+33",
          "number": "612345678"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    },
    "leader": true
  }
]

Loading...