Skip to content

Skills

List skill editors

List explicit skill editors and workspace Admins with cursor pagination. Built-in skills return an empty list. Requires workspace read access. OAuth scope: `api:read`.

GET/api/v2/skills/{skillId}/editors

List explicit skill editors and workspace Admins with cursor pagination. Built-in skills return an empty list. Requires workspace read access.

OAuth scope: api:read.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:read

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:read.

Path parameters

skillIdstringRequired

Unique skill identifier. A built-in skill is builtin- followed by its name, for example builtin-research.

minLength
1

Query parameters

workspaceIdstringRequired

Workspace that owns the skill.

minLength
1
maxLength
128
sortBystring

Field used to sort the result. Do not rely on case-insensitive ordering when sorting by name.

default
email
enum
["email","name"]
sortOrderstring

Sort direction.

default
asc
enum
["asc","desc"]
limitinteger

Maximum skill editors to return per page. Must be a whole number from 1 to 100. Defaults to 50.

default
50
minimum
1
maximum
100
cursorstring

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

minLength
1

Responses

200

Users who can edit the skill.

object

Identity fields for users who can edit the skill.

2 fields
dataarrayRequired

Items in the current page.

Schema details
Array itemobject

Public identity fields for a user who can edit a skill.

4 fields
emailstringRequired

Email address of the skill editor.

format
email
pattern
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
namevalueRequired

Display name of the skill editor.

Schema details

Any of

Option 1string
Option 2null
imagevalueRequired

Profile image URL of the skill editor.

Schema details

Any of

Option 1string
Option 2null
isWorkspaceAdminbooleanRequired

Whether editor access is derived from workspace administration.

Additional properties are not allowed.

nextCursorvalueRequired

Opaque cursor for the next page. Send it back as cursor; null means there are no more pages. Do not construct a cursor yourself.

Schema details

Any of

Option 1string
Option 2null

Additional properties are not allowed.

Response example 1

json
{
  "data": [
    {
      "email": "jane@example.com",
      "name": "Jane Smith",
      "image": null,
      "isWorkspaceAdmin": false
    }
  ],
  "nextCursor": null
}

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit