Skip to main content

Download bulk invite Excel template

GET 

/v1/spaces/:spaceId/users/invitations:bulkImport/template

Preview: The API is in development or testing phases and the interface could still change slightly.

Returns a pre-formatted Excel (.xlsx) template for use with the bulk import endpoint.

The template contains:

  • Identity columns: firstName, lastName, email
  • One column per role: space_admin, purchases_full, purchases_limited, sales_full, sales_limited, financial_full, accountant
  • Yes/no dropdown validation on every role column (rows 2–101)
  • A sample row illustrating the expected format
  • Colour-coded headers: grey for identity fields, blue for role columns

Use the optional language query parameter to receive column headers translated into the requested language. Supported values: en (default), fr.

Fill in the template and upload it via POST /v1/spaces/{spaceId}/users/invitations:bulkImport.
Scope: []

Request

Responses

Excel template file ready to fill in

Response Headers
    Content-Disposition
    Example: attachment; filename="bulk_invite_template.xlsx"