# FinSpace Public API API

> FinSpace Public API API on Apizie: 31 endpoints (Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace., Removes a user account from a permission group., Lists the FinSpace Changesets for a Dataset., Creates a new Changeset in a FinSpace Dataset., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:amazonaws-finspace-data/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-finspace-data`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://apizie.tech/api/cloud/amazonaws-finspace-data
- OpenAPI: https://apizie.tech/api/cloud/amazonaws-finspace-data/openapi.json

The FinSpace APIs let you take actions inside the FinSpace.

## Endpoints

### Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/associate-user-to-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group. |
| userId | string | yes | The unique identifier for the user. |
| body | object | yes | JSON request body |

### Removes a user account from a permission group.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/disassociate-user-from-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group. |
| userId | string | yes | The unique identifier for the user. |
| clientToken | string | no | A token that ensures idempotency. This token expires in 10 minutes. |

### Lists the FinSpace Changesets for a Dataset.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-changesets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for the FinSpace Dataset to which the Changeset belongs. |
| maxResults | integer | no | The maximum number of results per page. |
| nextToken | string | no | A token that indicates where a results page should begin. |

### Creates a new Changeset in a FinSpace Dataset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/create-changeset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for the FinSpace Dataset where the Changeset will be created. |
| body | object | yes | JSON request body |

### Lists all available Dataviews for a Dataset.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-data-views` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier of the Dataset for which to retrieve Dataviews. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results per page. |

### Creates a Dataview for a Dataset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/create-data-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique Dataset identifier that is used to create a Dataview. |
| body | object | yes | JSON request body |

### Lists all of the active Datasets that a user has access to.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | no | The maximum number of results per page. |

### Creates a new FinSpace Dataset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a group of permissions for various actions that a user can perform in FinSpace.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/create-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new user in FinSpace.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns information about a Dataset.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for a Dataset. |

### Updates a FinSpace Dataset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/update-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for the Dataset to update. |
| body | object | yes | JSON request body |

### Deletes a FinSpace Dataset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| clientToken | string | no | A token that ensures idempotency. This token expires in 10 minutes. |
| datasetId | string | yes | The unique identifier of the Dataset to be deleted. |

### Retrieves the details of a specific permission group.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group. |

### Modifies the details of a permission group. You cannot modify a permissionGroupID .
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/update-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group to update. |
| body | object | yes | JSON request body |

### Deletes a permission group. This action is irreversible.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/delete-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group that you want to delete. |
| clientToken | string | no | A token that ensures idempotency. This token expires in 10 minutes. |

### Denies access to the FinSpace web application and API for the specified user.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/disable-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier for the user account that you want to disable. |
| body | object | yes | JSON request body |

### Allows the specified user to access the FinSpace web application and API.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/enable-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier for the user account that you want to enable. |
| body | object | yes | JSON request body |

### Get information about a Changeset.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-changeset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for the FinSpace Dataset where the Changeset is created. |
| changesetId | string | yes | The unique identifier of the Changeset for which to get data. |

### Updates a FinSpace Changeset.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/update-changeset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| datasetId | string | yes | The unique identifier for the FinSpace Dataset in which the Changeset is created. |
| changesetId | string | yes | The unique identifier for the Changeset to update. |
| body | object | yes | JSON request body |

### Gets information about a Dataview.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-data-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| dataviewId | string | yes | The unique identifier for the Dataview. |
| datasetId | string | yes | The unique identifier for the Dataset used in the Dataview. |

### Returns the credentials to access the external Dataview from an S3 location. To call this API: You must…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-external-data-view-access-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| dataviewId | string | yes | The unique identifier for the Dataview that you want to access. |
| datasetId | string | yes | The unique identifier for the Dataset. |

### Request programmatic credentials to use with FinSpace SDK.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-programmatic-access-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| durationInMinutes | integer | no | The time duration in which the credentials remain valid. |
| environmentId | string | yes | The FinSpace environment identifier. |

### Retrieves details for a specific user.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier of the user to get data for. |

### Modifies the details of the specified user account. You cannot update the userId for a user.
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier for the user account to update. |
| body | object | yes | JSON request body |

### A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/get-working-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Lists all available permission groups in FinSpace.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-permission-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | yes | The maximum number of results per page. |

### Lists all the permission groups that are associated with a specific user account.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-permission-groups-by-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier for the user. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | yes | The maximum number of results per page. |

### Lists all available user accounts in FinSpace.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | yes | The maximum number of results per page. |

### Lists details of all the users in a specific permission group.
`GET https://apizie.tech/v1/cloud:amazonaws-finspace-data/list-users-by-permission-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| permissionGroupId | string | yes | The unique identifier for the permission group. |
| nextToken | string | no | A token that indicates where a results page should begin. |
| maxResults | integer | yes | The maximum number of results per page. |

### Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset…
`POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/reset-user-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| userId | string | yes | The unique identifier of the user that a temporary password is requested for. |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/cloud:amazonaws-finspace-data/associate-user-to-permission-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the FinSpace Public API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:amazonaws-finspace-data/associate-user-to-permission-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the FinSpace Public API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. FinSpace Public API itself also needs your own key from amazonaws.com.

### Can AI agents use the FinSpace Public API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-finspace-data.

### What is the status of the FinSpace Public API API?
Needs your own provider key (bring your own key)