DokumentacjaEngagement Platform API
Sign inGet started
Guides
API

Workspaces

GET
/organizations/{organizationId}/workspaces
List the workspaces for the organization.
Parametry zapytania
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Treść odpowiedzi
results
array of object
wymagane
List of results.
Pokaż atrybuty podrzędne
results.id
string
wymagane
Workspace ID.
results.organizationId
string
wymagane
ID of the organization this workspace is part of.
results.status
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
results.statusTransitions
array of object
Pokaż atrybuty podrzędne
results.statusTransitions.fromStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
results.statusTransitions.toStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
results.statusTransitions.reason
string
wymagane
Possible values: org-banned, user-initiated, payment-default, inactivity
results.statusTransitions.comment
string
results.statusTransitions.transitionedAt
string
wymagane
results.statusTransitions.transitionedBy
object
wymagane
Pokaż atrybuty podrzędne
results.statusTransitions.transitionedBy.id
string
wymagane
results.statusTransitions.transitionedBy.type
string
wymagane
Possible values: user, accesskey, contact
results.name
string
wymagane
The display name for the workspace
results.description
string
The description for the workspace
results.dataPolicy
object
wymagane
The data storage policy for a resource.
Pokaż atrybuty podrzędne
results.dataPolicy.group
string
wymagane
The name of the region group used for storage.
results.dataPolicy.regions
array of object
wymagane
Pokaż atrybuty podrzędne
results.dataPolicy.regions.region
string
wymagane
The name of the AWS region.
results.dataPolicy.regions.priority
integer
wymagane
The priority to give to this region when storing data.
results.dataPolicy.piiStrategy
string
wymagane
Possible values: default, strict
results.configuration
object
Pokaż atrybuty podrzędne
results.configuration.domain
string
Domain name.
results.createdAt
string
wymagane
When the workspace was created.
results.updatedAt
string
wymagane
When the workspace was last updated.
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Przykład kodu
curl -X GET 'https://api.bird.com/organizations/{organizationId}/workspaces' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/organizations/{organizationId}/workspaces
Create a workspace for the organization.
Treść żądania
name
string
wymagane
The display name for the workspace
description
string
The description for the workspace
dataPolicy
object
wymagane
The data storage policy for a resource.
Pokaż parametry podrzędne
dataPolicy.group
string
wymagane
The name of the region group used for storage. Must be one of us-west-2, eu-west-1, or ap-south-1.
dataPolicy.regions
array of object
wymagane
Pokaż parametry podrzędne
dataPolicy.regions.region
string
wymagane
The name of the AWS region. Must be one of us-west-2, eu-west-1, or ap-south-1.
dataPolicy.regions.priority
integer
wymagane
The priority to give to this region when storing data.
configuration
object
Pokaż parametry podrzędne
configuration.domain
string
Domain name.
userUsername
string
The username of the user that is creating the workspace.
flavors
array of string
Treść odpowiedzi
id
string
wymagane
Workspace ID.
organizationId
string
wymagane
ID of the organization this workspace is part of.
status
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions
array of object
Pokaż atrybuty podrzędne
statusTransitions.fromStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.toStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.reason
string
wymagane
Possible values: org-banned, user-initiated, payment-default, inactivity
statusTransitions.comment
string
statusTransitions.transitionedAt
string
wymagane
statusTransitions.transitionedBy
object
wymagane
Pokaż atrybuty podrzędne
statusTransitions.transitionedBy.id
string
wymagane
statusTransitions.transitionedBy.type
string
wymagane
Possible values: user, accesskey, contact
name
string
wymagane
The display name for the workspace
description
string
The description for the workspace
dataPolicy
object
wymagane
The data storage policy for a resource.
Pokaż atrybuty podrzędne
dataPolicy.group
string
wymagane
The name of the region group used for storage.
dataPolicy.regions
array of object
wymagane
Pokaż atrybuty podrzędne
dataPolicy.regions.region
string
wymagane
The name of the AWS region.
dataPolicy.regions.priority
integer
wymagane
The priority to give to this region when storing data.
dataPolicy.piiStrategy
string
wymagane
Possible values: default, strict
configuration
object
Pokaż atrybuty podrzędne
configuration.domain
string
Domain name.
createdAt
string
wymagane
When the workspace was created.
updatedAt
string
wymagane
When the workspace was last updated.
Przykład kodu
curl -X POST 'https://api.bird.com/organizations/{organizationId}/workspaces' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/organizations/{organizationId}/workspaces/{workspaceId}
Get the workspace instance.
Treść odpowiedzi
id
string
wymagane
Workspace ID.
organizationId
string
wymagane
ID of the organization this workspace is part of.
status
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions
array of object
Pokaż atrybuty podrzędne
statusTransitions.fromStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.toStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.reason
string
wymagane
Possible values: org-banned, user-initiated, payment-default, inactivity
statusTransitions.comment
string
statusTransitions.transitionedAt
string
wymagane
statusTransitions.transitionedBy
object
wymagane
Pokaż atrybuty podrzędne
statusTransitions.transitionedBy.id
string
wymagane
statusTransitions.transitionedBy.type
string
wymagane
Possible values: user, accesskey, contact
name
string
wymagane
The display name for the workspace
description
string
The description for the workspace
dataPolicy
object
wymagane
The data storage policy for a resource.
Pokaż atrybuty podrzędne
dataPolicy.group
string
wymagane
The name of the region group used for storage.
dataPolicy.regions
array of object
wymagane
Pokaż atrybuty podrzędne
dataPolicy.regions.region
string
wymagane
The name of the AWS region.
dataPolicy.regions.priority
integer
wymagane
The priority to give to this region when storing data.
dataPolicy.piiStrategy
string
wymagane
Possible values: default, strict
configuration
object
Pokaż atrybuty podrzędne
configuration.domain
string
Domain name.
createdAt
string
wymagane
When the workspace was created.
updatedAt
string
wymagane
When the workspace was last updated.
Przykład kodu
curl -X GET 'https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/organizations/{organizationId}/workspaces/{workspaceId}
Delete a workspace from the organization.
Przykład kodu
curl -X DELETE 'https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/workspaces/{workspaceId}
Update a workspace's properties.
Treść żądania
name
string
The display name for the workspace
description
string
The description for the workspace
Treść odpowiedzi
id
string
wymagane
Workspace ID.
organizationId
string
wymagane
ID of the organization this workspace is part of.
status
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions
array of object
Pokaż atrybuty podrzędne
statusTransitions.fromStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.toStatus
string
wymagane
Status of the workspace
Possible values: active, disabled, terminated, deleted
statusTransitions.reason
string
wymagane
Possible values: org-banned, user-initiated, payment-default, inactivity
statusTransitions.comment
string
statusTransitions.transitionedAt
string
wymagane
statusTransitions.transitionedBy
object
wymagane
Pokaż atrybuty podrzędne
statusTransitions.transitionedBy.id
string
wymagane
statusTransitions.transitionedBy.type
string
wymagane
Possible values: user, accesskey, contact
name
string
wymagane
The display name for the workspace
description
string
The description for the workspace
dataPolicy
object
wymagane
The data storage policy for a resource.
Pokaż atrybuty podrzędne
dataPolicy.group
string
wymagane
The name of the region group used for storage.
dataPolicy.regions
array of object
wymagane
Pokaż atrybuty podrzędne
dataPolicy.regions.region
string
wymagane
The name of the AWS region.
dataPolicy.regions.priority
integer
wymagane
The priority to give to this region when storing data.
dataPolicy.piiStrategy
string
wymagane
Possible values: default, strict
configuration
object
Pokaż atrybuty podrzędne
configuration.domain
string
Domain name.
createdAt
string
wymagane
When the workspace was created.
updatedAt
string
wymagane
When the workspace was last updated.
Przykład kodu
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/workspaces/{workspaceId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'