Finalcad Members API

openapi: 3.2.0
info:
  title: Finalcad One Organization Management Members API
  version: '2.41'
  summary: 'Organization-level administration of a Finalcad One Enterprise tenant: workspaces, members and roles, observation status / trade / common-observation / priority / form-template libraries, form and observation module types, data referentials, and Power BI dataset configuration.'
  description: 'Organization-level administration of a Finalcad One Enterprise tenant: workspaces, members and roles, observation status / trade / common-observation / priority / form-template libraries, form and observation module types, data referentials, and Power BI dataset configuration.


    DERIVED, NOT PUBLISHED BY THE PROVIDER. Finalcad publishes no OpenAPI. This document was mechanically derived by API Evangelist from the first-party public Postman collection "Finalcad One API" served by Finalcad at https://developer.finalcad.com/ (collection JSON: https://developer.finalcad.com/api/collections/10995648/Tz5v1Es2), saved in this repo at collections/finalcad.postman_collection.json. Every path, method, header, query parameter, example request body and example response below is carried over from that collection; nothing was invented. Request/response bodies are typed as generic objects because the collection carries examples, not schemas. Four Finalcad employees'' personal e-mail addresses that appeared in the collection''s example payloads were replaced with placeholders; nothing else was changed.'
  contact:
    name: Finalcad One API — developer portal
    url: https://developer.finalcad.com/
  x-generated-by: API Evangelist enrichment pipeline (derived from the first-party Postman collection)
  x-source: collections/finalcad.postman_collection.json
  x-source-url: https://developer.finalcad.com/
servers:
- url: https://developer.finalcad.cloud/api
  description: Production — the baseUrl variable published in the Finalcad One API Postman collection.
- url: https://developer.sandbox.finalcad.cloud/api
  description: Sandbox — published by Finalcad in the 'Retrieve data in Power BI' tutorial of the same collection.
security:
- apiKey: []
  tokenAuth: []
tags:
- name: Members
paths:
  /organizations/user-infos/{user_id}:
    get:
      operationId: membersGetUserInformation
      summary: Get user information
      description: "You can check member info.\n\n Endpoint mandatory infos \n Details \n\n user_id \n the id of the user to be checked"
      tags:
      - Members
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `user_id` as published in the collection.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Success:
                  value:
                    id: <my_user_id>
                    first_name: <my_first_name>
                    last_name: <my_name>
                    email: <my_email>
                    is_active: 'true'
                    email_validated: 'true'
                    created_at: '2022-06-02T07:28:34.483278Z'
                    updated_at: '2023-07-26T13:24:40.68237Z'
                    media_resource:
                      id: 737a4362-0371-4742-9b58-ffe4d4d2e768
                      file_name: logo.png
                      mime_type: image/png
                      created_at: '2023-07-26T13:24:40.672379Z'
        '400':
          description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized — the API key or user token is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /organizations/{organization_id}/add-members:
    post:
      operationId: membersAddMembers
      summary: Add members
      description: "To ease this step, you can directly add a list of members. Your invitations can fall into two cases:\n\n The email is already linked to a Finalcad One account. The member will be directly added to the project and receive a notification.\n\n The email is not linked to a Finalcad One account. The member will be invited to create an account by email. Meanwhile, the invitations will be visible as pending in the organization member list.\n\n To invite a member to your project, an email needs to be associated with a project role. See Get roles . \n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of the project to be modified \n\n body mandatory infos \n Details \n\n role_users \n list of roles and users \neach contains : \n\n role_id \n organization role id to be used \nif missing , use the default one \n\n users_info \n list of user_id or email as string"
      tags:
      - Members
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_id` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              role_users:
              - role_id: e735e603-225a-47d1-bd39-72a1afae7c9f
                users_info:
                - the_user_email
                - another_email
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized — the API key or user token is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /organizations/{organization_id}/change-members-role:
    post:
      operationId: membersChangeRole
      summary: Change role
      description: "You can change the role of a user.\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of the project to be modified \n\n body mandatory infos \n Details \n\n role_id \n organization role id to be used \n\n users_info \n list of user_id to be changed"
      tags:
      - Members
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_id` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
              users_info:
              - the_user_id
              - another_user_id
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized — the API key or user token is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /organizations/{organization_id}/change-members-role-bulk:
    post:
      operationId: membersChangeSeveralRoles
      summary: Change several roles
      description: "You can change several roles for several users.\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of the organization to be modified \n\n body mandatory infos \n Details \n --- \n\n List of \n\n role_id \n organization role id to be used \n\n users_info \n list of user_id to be changed"
      tags:
      - Members
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_id` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized — the API key or user token is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /organizations/{organization_id}/members:
    post:
      operationId: membersGetMembers
      summary: Get members
      description: "Before adding members to your project, you might want to have an overview of the current organization users and their roles.\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of the organization to be checked \n\n Query params optionals \n\n see Commmon behaviors / differential \n\n Body optional infos \n Details \n\n search_term \n search term for the email user field \n\n roles \n list of organization roles to filter the users list \nthis filed is ignored if the search_term is used \n\n with_processing_members \n include or not the processing users"
      tags:
      - Members
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_id` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              with_processing_members: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Success:
                  value:
                    organization_members:
                    - id: 427380db-f465-48bd-a2d7-6788a4b07adc
                      membership_type: Member
                      user_id: 674ddb3e-6ce0fe28-6e85-4d0b-9efc-666f8c7fe7e6
                      legacy_id: 500001965
                      email: person.redacted@example.com
                      first_name: Damien
                      last_name: IROUVA
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2023-06-21T13:04:10.052724Z'
                      updated_at: '2023-06-21T13:04:18.272385Z'
                    - id: 966112b7-c1ab-4d43-895c-0dac53f13b41
                      membership_type: Member
                      user_id: 4b9382b5-e2d6a638-5011-4a9a-b3ac-9f87db62800b
                      legacy_id: 500004270
                      email: person.redacted+sandbox@example.com
                      first_name: Eivyda
                      last_name: JANKUNAITE
                      media_resource:
                        id: 024afa60-36f5-4db4-99c9-306d10f7e1b9
                        file_name: images.jpeg
                        mime_type: image/jpeg
                        created_at: '2023-03-20T08:57:51.725998Z'
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2023-03-02T13:16:29.80972Z'
                      updated_at: '2023-03-02T13:16:29.809737Z'
                    - id: 2b478519-c316-4026-9d3a-4293fe3fe110
                      membership_type: Member
                      user_id: b7a277a7-fadc0b1f-26b5-4800-97a1-33d935552c53
                      legacy_id: 500004484
                      email: person.redacted@example.com
                      first_name: Jade
                      last_name: ab
                      media_resource:
                        id: f775f8db-74f2-4bc6-a160-d34be8220f81
                        file_name: immeuble-de-bureaux-de-plan-52367600.jpeg
                        mime_type: image/jpeg
                        created_at: '2022-12-13T16:04:16.474872Z'
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2022-12-08T09:15:10.413826Z'
                      updated_at: '2022-12-08T09:15:10.413848Z'
                    - id: cd404d0f-ce28-4d42-bea7-969b8283ac20
                      membership_type: Member
                      user_id: 8b05d23b-b521f61b-de1c-46d1-9f81-c5b2621fe740
                      legacy_id: 500004839
                      email: person.redacted+plan@example.com
                      first_name: Jade
                      last_name: Abr
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2023-02-08T14:09:43.698678Z'
                      updated_at: '2023-02-08T15:01:08.940749Z'
                    - id: 798ca3db-bcb0-4b98-bbe9-8959c3b071b6
                      membership_type: Member
                      user_id: fdab2bfe-87196ebb-56c0-46ed-83c6-4bf803d86cf9
                      legacy_id: 500004723
                      email: person.redacted+test@example.com
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: true
                      is_processing: false
                      created_at: '2023-01-11T13:02:05.713988Z'
                      updated_at: '2023-01-11T13:02:05.714Z'
                    - id: f7172dae-fde8-42a2-8930-957e8d344666
                      membership_type: Member
                      user_id: 6996b70d-8fa9ce3a-dcf9-4bdd-a690-86d76294ec60
                      legacy_id: 500004724
                      email: person.redacted+test2@example.com
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: true
                      is_processing: false
                      created_at: '2023-01-11T13:07:46.741989Z'
                      updated_at: '2023-01-11T13:07:46.741991Z'
                    - id: 8f128201-35cf-4872-a928-d203eec7afd4
                      membership_type: Member
                      user_id: 5cf12ec0-fa67d814-befe-4055-a480-3bbbb34f6c01
                      legacy_id: 500003043
                      email: person.redacted@example.com
                      first_name: Josh
                      last_name: Josh
                      media_resource:
                        id: 28ceea7d-7741-4506-9191-cfbd5aa4bde2
                        file_name: josh.jpg
                        mime_type: image/jpeg
                        created_at: '2021-01-11T14:38:45.921Z'
                      organization_role:
                        id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        name: Organization member
                        names:
                          translation_fallback: Organization member
                          translations:
                          - language: nl
                            translation: Lid organisatie
                          - language: ja
                            translation: 組織メンバー
                          - language: pt
                            translation: Membro da organização
                          - language: it
                            translation: Membro organizzazione
                          - language: fr
                            translation: Membre de l'organisation
                          - language: vi
                            translation: Thành viên của tổ chức
                          - language: ca
                            translation: Membre de l'organització
                          - language: de
                            translation: Mitglied der Organisation
                          - language: zh
                            translation: 组织成员
                          - language: th
                            translation: สมาชิกองค์กร
                          - language: en
                            translation: Organization member
                          - language: es
                            translation: Miembro de la organización
                        is_default: true
                        is_default_invitation_role: false
                        user_count: 14
                        position: 0
                        authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e
                        higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2023-01-10T08:44:18.619122Z'
                      updated_at: '2023-01-10T08:44:18.619122Z'
                    - id: 5733cec1-5c27-492c-bf1d-c9feb90b6577
                      membership_type: Member
                      user_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
                      legacy_id: 500004439
                      email: person.redacted+sandbox@example.com
                      first_name: Luc
                      last_name: Vallot
                      organization_role:
                        id: e735e603-225a-47d1-bd39-72a1afae7c9f
                        name: Organization admin
                        names:
                          translation_fallback: Organization admin
                          translations:
                          - language: es
                            translation: Administrador de la organización
                          - language: ja
                            translation: 組織管理者
                          - language: zh
                            translation: 组织管理员
                          - language: vi
                            translation: Quản trị viên của tổ chức
                          - language: fr
                            translation: Administrateur de l'organisation
                          - language: ca
                            translation: Administrador de l'organització
                          - language: nl
                            translation: Beheer organisatie
                          - language: th
                            translation: ผู้ดูแลองค์กร
                          - language: de
                            translation: Administrator der Organisation
                          - language: it
                            translation: Amministratore organizzazione
                          - language: pt
                            translation: Admin da organização
                          - language: en
                            translation: Organization admin
                        is_default: false
                        is_default_invitation_role: false
                        user_count: 3
                        position: 0
                        authorization_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f
                        is_lower_role: false
                      is_pending: false
                      is_processing: false
                      created_at: '2022-06-30T08:35:05.940464Z'
                      updated_at: '2022-06-30T08:35:06.862619Z'
                    - id: 164dee2f-46db-47c1-80bf-db10c078504f
                      membership_type: Member
                      user_id: 8f0eebde-0fa7f000-f573-4054-b1a6-b92b002a513e
                      legacy_id: 5493
                      email: person-c@example.com
                      first_name: Mathieu
                      last_name: Bourgois
                      job_title: dev
         

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finalcad/refs/heads/main/openapi/finalcad-members-api-openapi.yml