Organizations
All organizations created with this API are considered standard Scaleway organizations, with a few differences:
- Special quotas will automatically be applied to all organizations without needing them to go through standard account verification.
- Organizations will not be billed at the end of the month.
Instead, you will receive an invoice with the aggregated consumption of all your organizations.
When you create an organization, you will be able to attach a custom
customer_ididentifier. You can use this identifier to associate a customer's ID in your infrastructure with the corresponding Scaleway organization. Depending on your customer's management process, you might need to lock one of your customers' organizations temporarily. When locked, a customer will no longer be able to perform any actions on the Scaleway ecosystem. Please note that a lock: - will NOT delete any customer data.
- will NOT stop already started resources.
List Organizations
query Parameters
page_sizepageorder_bystatusOnly list organizations with this status.
emailOnly list organizations created with this email.
customer_idOnly list organizations attached to this Customer ID. Only list organizations attached to this Customer ID. If the customer ID was changed only the last one can be used.
locked_byOnly list organizations locked by a certain entity.
List Organizations › Responses
List of organizations.
total_countTotal number of organizations.
Create a new organization
Create a new organization › Request Body
partner_idYour personal partner_id. This is the same as your Organization ID.
emailThe email of the new organization owner.
organization_nameThe name of the organization you want to create. Usually the company name.
owner_firstnameThe first name of the new organization owner.
owner_lastnameThe last name of the new organization owner.
customer_idA custom ID for the customer in your own infrastructure.
phone_numberThe phone number of the new organization owner.
siren_numberA SIREN number for the customer.
Create a new organization › Responses
idID of the organization. (UUID format)
nameName of the organization.
emailOrganization owner's email.
statusThe current status of the organization.
owner_firstnameOrganization owner's first name.
owner_lastnameOrganization owner's last name.
created_atDate of organization creation. (RFC 3339 format)
phone_numberOrganization owner's phone number.
siren_numberSiren number of the organization.
customer_idCustomer ID associated with this organization.
lock_reason_messageIf the organization is locked, this field will contain a human-readable reason.
locked_byOriginator of the lock. Can be one of "partner" or "scaleway".
locked_atDate of lock. (RFC 3339 format)
picture_linkLink to the Organization's picture.
commentA comment about the organization.
Get an organization
path Parameters
organization_idThe ID of the organization you want to GET.
Get an organization › Responses
idID of the organization. (UUID format)
nameName of the organization.
emailOrganization owner's email.
statusThe current status of the organization.
owner_firstnameOrganization owner's first name.
owner_lastnameOrganization owner's last name.
created_atDate of organization creation. (RFC 3339 format)
phone_numberOrganization owner's phone number.
siren_numberSiren number of the organization.
customer_idCustomer ID associated with this organization.
lock_reason_messageIf the organization is locked, this field will contain a human-readable reason.
locked_byOriginator of the lock. Can be one of "partner" or "scaleway".
locked_atDate of lock. (RFC 3339 format)
picture_linkLink to the Organization's picture.
commentA comment about the organization.
Update an organization
path Parameters
organization_idThe ID of the organization you want to update.
Update an organization › Request Body
emailThe new email.
nameThe new name.
owner_firstnameThe first name of the new owner.
owner_lastnameThe last name of the new owner.
phone_numberThe phone number of the new owner.
customer_idCustomer ID associated with this organization. Customer ID associated with this organization. Warning: Changing this value will only affect future invoices. If you try to change this value after the 25th of the month, we cannot guarantee that this will take effect on the invoice issued for the current month.
commentA comment about the organization.
Update an organization › Responses
idID of the organization. (UUID format)
nameName of the organization.
emailOrganization owner's email.
statusThe current status of the organization.
owner_firstnameOrganization owner's first name.
owner_lastnameOrganization owner's last name.
created_atDate of organization creation. (RFC 3339 format)
phone_numberOrganization owner's phone number.
siren_numberSiren number of the organization.
customer_idCustomer ID associated with this organization.
lock_reason_messageIf the organization is locked, this field will contain a human-readable reason.
locked_byOriginator of the lock. Can be one of "partner" or "scaleway".
locked_atDate of lock. (RFC 3339 format)
picture_linkLink to the Organization's picture.
commentA comment about the organization.
Lock an organization
path Parameters
organization_idThe ID of the organization you want to lock.
Lock an organization › Responses
idID of the organization. (UUID format)
nameName of the organization.
emailOrganization owner's email.
statusThe current status of the organization.
owner_firstnameOrganization owner's first name.
owner_lastnameOrganization owner's last name.
created_atDate of organization creation. (RFC 3339 format)
phone_numberOrganization owner's phone number.
siren_numberSiren number of the organization.
customer_idCustomer ID associated with this organization.
lock_reason_messageIf the organization is locked, this field will contain a human-readable reason.
locked_byOriginator of the lock. Can be one of "partner" or "scaleway".
locked_atDate of lock. (RFC 3339 format)
picture_linkLink to the Organization's picture.
commentA comment about the organization.
Invite a partner user in the customer organization
path Parameters
organization_idThe ID of the organization you want to be invited to.
Invite a partner user in the customer organization › Request Body
usernameThe member username.
emailThe member email.
passwordThe member password.
Invite a partner user in the customer organization › Responses
Unlock an organization
path Parameters
organization_idThe ID of the organization you want to unlock.
Unlock an organization › Responses
idID of the organization. (UUID format)
nameName of the organization.
emailOrganization owner's email.
statusThe current status of the organization.
owner_firstnameOrganization owner's first name.
owner_lastnameOrganization owner's last name.
created_atDate of organization creation. (RFC 3339 format)
phone_numberOrganization owner's phone number.
siren_numberSiren number of the organization.
customer_idCustomer ID associated with this organization.
lock_reason_messageIf the organization is locked, this field will contain a human-readable reason.
locked_byOriginator of the lock. Can be one of "partner" or "scaleway".
locked_atDate of lock. (RFC 3339 format)
picture_linkLink to the Organization's picture.
commentA comment about the organization.