Scopes

Personal scope, project scope, search scopes, and sharedWith.


Scope answers where a private record lives. Sharing answers which additional people can see it.

Create and update scope

Use scope when creating or updating private packs and tracks.

{ "scope": { "type": "personal" } }
{ "scope": { "type": "projects", "ids": ["project-id"] } }

Omitting scope on update preserves the existing scope.

Search scopes

Search uses scopes because a search can include multiple locations.

{
	"scopes": [{ "type": "personal" }, { "type": "projects", "ids": ["project-id"] }]
}

sharedWith

Use sharedWith to grant access to specific user IDs or emails in addition to the main scope.

{
	"sharedWith": {
		"userIds": ["user-id"],
		"emails": ["teammate@example.com"]
	}
}

Omitting sharedWith on update preserves the existing value.