Scale API

Studio Projects

studio_projects

Methods

Create Studio Project ->
StudioProject
post/v4/studio-projects

Description

Creates a studio project

Details

This API can be used to create a studio project. To use this API, review the request schema and pass in all fields that are required to create a studio project.

Delete Studio Project ->
GenericDeleteResponse
delete/v4/studio-projects/{studio_project_id}

Description

Deletes a studio project

Details

This API can be used to delete a studio project by ID. To use this API, pass in the id that was returned from your Create Studio Project API call as a path parameter.

List Studio Projects -> PageResponse<
StudioProject
>
get/v4/studio-projects

Description

Lists all studio projects accessible to the user.

Details

This API can be used to list studio projects. If a user has access to multiple accounts, all studio projects from all accounts the user is associated with will be returned.

Get Studio Project ->
StudioProject
get/v4/studio-projects/{studio_project_id}

Description

Gets the details of a studio project

Details

This API can be used to get information about a single studio project by ID. To use this API, pass in the id that was returned from your Create Studio Project API call as a path parameter.

Review the response schema to see the fields that will be returned.

Update Studio Project ->
StudioProject
patch/v4/studio-projects/{studio_project_id}

Description

Updates a studio project

Details

This API can be used to update the studio project that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Studio Project API call as a path parameter.

Review the request schema to see the fields that can be updated.

Domain types

PaginatedStudioProjects = { current_page, items, items_per_page, 1 more... }
StudioProject = { id, account_id, created_at, 3 more... }