Scaleway logo
Partner API
Partner API

Organizations

Download schema

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_id identifier. 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

GET
https://api.scaleway.com
/partner/v1/organizations

List Organizations › query Parameters

page_size
​integer · uint32
page
​google.protobuf.Int32Value · int32
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

Only list organizations with this status.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
email
​string

Only list organizations created with this email.

customer_id
​string

Only 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.

Only list organizations locked by a certain entity.

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by

List Organizations › Responses

200
scaleway.partner.v1.ListOrganizationsResponse

List of organizations.

total_count
​integer · uint64

Total number of organizations.

Create a new organization

POST
https://api.scaleway.com
/partner/v1/organizations

Create a new organization › Request Body

partner_id
​string · required

Your personal partner_id. This is the same as your Organization ID.

email
​string · required

The email of the new organization owner.

organization_name
​string · required

The name of the organization you want to create. Usually the company name.

owner_firstname
​string · required

The first name of the new organization owner.

owner_lastname
​string · required

The last name of the new organization owner.

customer_id
​string · required

A custom ID for the customer in your own infrastructure.

phone_number
​string | null

The phone number of the new organization owner.

comment
​string | null

A comment about the organization.

Create a new organization › Responses

200
scaleway.partner.v1.Organization
id
​string

ID of the organization. (UUID format)

name
​string

Name of the organization.

email
​string

Organization owner's email.

The current status of the organization.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
owner_firstname
​string

Organization owner's first name.

owner_lastname
​string

Organization owner's last name.

created_at
​string | null · date-time

Date of organization creation. (RFC 3339 format)

phone_number
​string | null

Organization owner's phone number.

customer_id
​string

Customer ID associated with this organization.

lock_reason_message
​string

If the organization is locked, this field will contain a human-readable reason.

Originator of the lock. Can be one of "partner" or "scaleway".

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by
locked_at
​string | null · date-time

Date of lock. (RFC 3339 format)

picture_link
​string | null

Link to the Organization's picture.

comment
​string

A comment about the organization.

Get an organization

GET
https://api.scaleway.com
/partner/v1/organizations/{organization_id}

Get an organization › path Parameters

organization_id
​string · required

The ID of the organization you want to GET.

Get an organization › Responses

200
scaleway.partner.v1.Organization
id
​string

ID of the organization. (UUID format)

name
​string

Name of the organization.

email
​string

Organization owner's email.

The current status of the organization.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
owner_firstname
​string

Organization owner's first name.

owner_lastname
​string

Organization owner's last name.

created_at
​string | null · date-time

Date of organization creation. (RFC 3339 format)

phone_number
​string | null

Organization owner's phone number.

customer_id
​string

Customer ID associated with this organization.

lock_reason_message
​string

If the organization is locked, this field will contain a human-readable reason.

Originator of the lock. Can be one of "partner" or "scaleway".

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by
locked_at
​string | null · date-time

Date of lock. (RFC 3339 format)

picture_link
​string | null

Link to the Organization's picture.

comment
​string

A comment about the organization.

Update an organization

PATCH
https://api.scaleway.com
/partner/v1/organizations/{organization_id}

Update an organization › path Parameters

organization_id
​string · required

The ID of the organization you want to update.

Update an organization › Request Body

email
​string | null

The new email.

name
​string | null

The new name.

owner_firstname
​string | null

The first name of the new owner.

owner_lastname
​string | null

The last name of the new owner.

phone_number
​string | null

The phone number of the new owner.

customer_id
​string | null

Customer 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.

comment
​string | null

A comment about the organization.

Update an organization › Responses

200
scaleway.partner.v1.Organization
id
​string

ID of the organization. (UUID format)

name
​string

Name of the organization.

email
​string

Organization owner's email.

The current status of the organization.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
owner_firstname
​string

Organization owner's first name.

owner_lastname
​string

Organization owner's last name.

created_at
​string | null · date-time

Date of organization creation. (RFC 3339 format)

phone_number
​string | null

Organization owner's phone number.

customer_id
​string

Customer ID associated with this organization.

lock_reason_message
​string

If the organization is locked, this field will contain a human-readable reason.

Originator of the lock. Can be one of "partner" or "scaleway".

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by
locked_at
​string | null · date-time

Date of lock. (RFC 3339 format)

picture_link
​string | null

Link to the Organization's picture.

comment
​string

A comment about the organization.

Lock an organization

POST
https://api.scaleway.com
/partner/v1/organizations/{organization_id}/lock

Lock an organization › path Parameters

organization_id
​string · required

The ID of the organization you want to lock.

Lock an organization › Request Body

Lock an organization › Responses

200
scaleway.partner.v1.Organization
id
​string

ID of the organization. (UUID format)

name
​string

Name of the organization.

email
​string

Organization owner's email.

The current status of the organization.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
owner_firstname
​string

Organization owner's first name.

owner_lastname
​string

Organization owner's last name.

created_at
​string | null · date-time

Date of organization creation. (RFC 3339 format)

phone_number
​string | null

Organization owner's phone number.

customer_id
​string

Customer ID associated with this organization.

lock_reason_message
​string

If the organization is locked, this field will contain a human-readable reason.

Originator of the lock. Can be one of "partner" or "scaleway".

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by
locked_at
​string | null · date-time

Date of lock. (RFC 3339 format)

picture_link
​string | null

Link to the Organization's picture.

comment
​string

A comment about the organization.

Invite a partner user in the customer organization

POST
https://api.scaleway.com
/partner/v1/organizations/{organization_id}/request-admin-role

Invite a partner user in the customer organization › path Parameters

organization_id
​string · required

The ID of the organization you want to be invited to.

Invite a partner user in the customer organization › Request Body

username
​string

The member username.

email
​string

The member email.

password
​string

The member password.

Invite a partner user in the customer organization › Responses

No data returned

Unlock an organization

POST
https://api.scaleway.com
/partner/v1/organizations/{organization_id}/unlock

Unlock an organization › path Parameters

organization_id
​string · required

The ID of the organization you want to unlock.

Unlock an organization › Request Body

Unlock an organization › Responses

200
scaleway.partner.v1.Organization
id
​string

ID of the organization. (UUID format)

name
​string

Name of the organization.

email
​string

Organization owner's email.

The current status of the organization.

Enum values:
unknown_status
opened
locked
closed
Default: unknown_status
owner_firstname
​string

Organization owner's first name.

owner_lastname
​string

Organization owner's last name.

created_at
​string | null · date-time

Date of organization creation. (RFC 3339 format)

phone_number
​string | null

Organization owner's phone number.

customer_id
​string

Customer ID associated with this organization.

lock_reason_message
​string

If the organization is locked, this field will contain a human-readable reason.

Originator of the lock. Can be one of "partner" or "scaleway".

Enum values:
unknown_locked_by
partner
scaleway
Default: unknown_locked_by
locked_at
​string | null · date-time

Date of lock. (RFC 3339 format)

picture_link
​string | null

Link to the Organization's picture.

comment
​string

A comment about the organization.