Skip to content
Menu
SilktideDevelopers

List the account's roles and users as assignees

GET/v1/assignees
View as Markdown

Returns everyone and every role in the account that can be given something, such as a report to receive or a check to fix, keyed by assignee id. Use these ids wherever an operation asks for assigneeIds.

The answer is an object, not a list: read it by key, or take its values. Roles come first, Everyone leading, then users, each in name order.

Roles and users have different fields. Both have assigneeId, assigneeType and displayName; read the rest by assigneeType. Roles are still called groups here (group, groupId, ids starting g:): that is the name roles had before.

Older documentation listed eight assignee types. This list only ever holds group and user.

Request
curl "https://api.eu.silktide.com/v1/assignees" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: An account with two roles and two users
{
  "g:1": {
    "groupId": 1,
    "displayName": "Everyone",
    "description": "All users in this Account.",
    "icon": "fas fa-globe",
    "colorScheme": "sky",
    "assigneeId": "g:1",
    "assigneeType": "group",
    "name": "Everyone"
  },
  "g:2": {
    "groupId": 2,
    "displayName": "Account administrators",
    "description": "People with total control of this account",
    "icon": "fas fa-crown",
    "colorScheme": "amber",
    "assigneeId": "g:2",
    "assigneeType": "group",
    "name": "Account administrators"
  },
  "u:eu-12": {
    "userId": "eu-12",
    "fullName": "Jordan Rivera",
    "displayName": "Jordan",
    "email": "jordan.rivera@example.com",
    "position": "Web editor",
    "thumbnailUrl": "https://example.com/people/jordan.png",
    "assigneeId": "u:eu-12",
    "assigneeType": "user"
  },
  "u:eu-15": {
    "userId": "eu-15",
    "fullName": "Sam Okafor",
    "displayName": "Sam Okafor",
    "email": "sam.okafor@example.com",
    "position": "",
    "thumbnailUrl": "",
    "assigneeId": "u:eu-15",
    "assigneeType": "user"
  }
}

Request

No parameters.

Response

200A map of objects. Every role, then every user, in the account, keyed by assignee id.

  • assigneeIdstringrequiredmatches ^[gu]:

    The assignee's id, the same as its key: g: and a role id, or u: and a user id.

  • assigneeTypestringrequired

    group for a role, user for a person.

    One ofgroupuser

  • displayNamestringrequired

    The name to show: a role's name, or the name a person chose to be shown by.

  • groupIdintegerat least 1

    The role's id, its roleId. Roles only.

  • namestring

    The role's name again, as older integrations read it. Roles only.

  • descriptionstring

    What the role is for. Can be empty. Roles only.

  • iconstring

    A Font Awesome icon class, such as fas fa-globe. Can be empty. Roles only.

  • colorSchemestring

    The color Silktide shows the role in. Empty when it has none. Roles only.

    One ofskyemeraldamberroseorangevioletindigocyanfuchsiaslate

  • userIdstring

    The user's id: their region, a hyphen and a number, such as eu-12. Users only.

  • fullNamestring

    The person's full name. Users only.

  • emailstring

    Their email address. Users only.

  • positionstring

    Their job title. Empty when they have not given one. Users only.

  • thumbnailUrlstring

    A URL of their picture. Empty when they have none. Users only.

Errors

StatusTypeWhen
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation)
503-Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation)

Every error has the same body. See Errors.

Access

Permission
Any user of the account
Plan feature
None
Edition
Silktide 4 and Silktide 5
Cost
Free
Available since
v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.