Reference documentation for the projects HTTP endpoint.
Manage your Sanity projects.
For endpoints related to managing a project's user roles, see the Roles HTTP reference
Sanity API base URL
https://api.sanity.io/{apiVersion}"v2021-06-07"API version
A list of projects.
application/jsonThe display name of the project.
My ProjectAssign the created project to the specified organization. The organization to which organizationId belongs must already exist and you must have sufficient permissions to assign a project to the organization. If omitted, the project is assigned to your personal account.
org_123falsefalsefalsetruewefsadfj2021-01-01T00:00:00Z2021-01-01T00:00:00Z#000000This field is deprecated. Use the /user-applications API instead.
https://my-project.my-domain.comProject created successfully.
The unique ID of the project.
Project details.
The unique ID of the project.
application/jsonYour studio hostname for deployment on Sanity's hosted service: https://
https://my-project.sanity.studioThe color of the project.
#000000The external studio hostname for deployment on a custom domain.
https://my-project.my-domain.comProject updated successfully.
The unique ID of the project.
Project deleted successfully.
/projects/{projectId}/corsReturns a list of all CORS origins for a specific project.
A list of CORS entries.
/projects/{projectId}/cors/{id}Deletes a specific CORS origin for a project.
/projects/{projectId}/datasetsReturns a list of all datasets for the project.
/projects/{projectId}/datasets/{name}Returns the details of a specific dataset by name.
/projects/{projectId}/datasets/{name}Updates a specific dataset in the project.
/projects/{projectId}/datasets/{name}/copyCopies a dataset to a new dataset.
This is a feature available to Business and Enterprise customers.
The unique ID of the project.
The name of the dataset to copy.
application/jsonThe name of the new dataset to create.
If true, revision history is not copied, which will usually result in a much faster copy.
If false or omitted, revision history is copied to targetDataset.
The ACL mode to set for the new dataset.
OK
/projects/{projectId}/datasets/{name}/copyList copy jobs history for a dataset.
This is a feature available to Business and Enterprise customers.
The unique ID of the project.
The name of the dataset.
Start position in list.
Number of items to return.
Comma separated list of job states.
OK
123456pending2021-01-01T00:00:00Z2021-01-01T00:00:00Zmy-datasetmy-dataset-copy/projects/{projectId}/featuresReturns a list of active features for the project.
The unique ID of the project.
OK
privateDataset/projects/{projectId}/permissionsReturns a list of permissions for the project.
The unique ID of the project.
OK
The unique ID of the project.
The unique ID of the user.
If authenticated with a user token, you can substitute "me" for the user ID.
OK
/projects/{projectId}/tokensReturns a list of tokens for the project.
This endpoint does not reveal the actual token, only details about the token.
/projects/{projectId}/tokensCreates a new token for the project.
The unique ID of the project.
application/jsonA descriptive label for your token. This can help you identify it later so you know where it's being used.
The permissions to assign your token. These will vary by plan. On a Free plan, roleName must be viewer, editor, or deploy-studio.
/projects/{projectId}/tokens/{tokenId}Deletes a token for the project.
/projects/{projectId}/datasets/{name}/tagsReturns a list of tags for the dataset.
/projects/{projectId}/tagsCreates a new tag for the project.
Datasets cannot be assigned at tag creation. Use the PUT endpoint to assign datasets to the tag.
The unique ID of the project.
application/jsonThe title of the tag.
The name of the tag.
The description of the tag.
A set of additional configuration options
The color of your tag.
The unique ID of the project.
The unique ID of the tag.
application/jsonThe title of the tag.
The name of the tag.
The description of the tag.
A set of additional configuration options
The color of your tag.
/projects/{projectId}/tags/{tagIdentifier}Deletes a tag by identifier.
The tag must not be assigned to any datasets.
The unique ID of the project.
The unique ID of the tag.
/projects/{projectId}/datasets/{datasetName}/tags/{tagIdentifier}Assigns a tag to a dataset.
The unique ID of the project.
The name of the dataset.
The unique ID of the tag.
OK
/projects/{projectId}/datasets/{datasetName}/tags/{tagIdentifier}Removes a tag from a dataset.
The unique ID of the project.
The name of the dataset.
The unique ID of the tag.