Subscriptions

Get users that use the subscription with their individual access permissions.

get/api/v1/subscriptions/{subscriptionId}/users

Request

  • Base URL: https://api.chiligrafx.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.chiligrafx.com/api/v1/subscriptions/{subscriptionId}/users
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring uuid required

Subscription Id.

Response

Returns array of user details.

idstring required

User Id.

emailstring required

User email.

firstNamestring nullable

User first name.

lastNamestring nullable

User last name.

avatarstring nullable

Link to avatar picture.

lastSeeninteger nullable

Last login datetime in seconds (unit timestamp).

status'Active' | 'Blocked' | 'Pending' | 'Inactive'

Status of a user.

subscriptionRolesstring[] nullable

Subscription roles.

hasFullAccessboolean required

If a user is a Chili Administrator.

isFederatedboolean

Is user federated.

membershipType'Invitation' | 'Federated'

Example response

[
  {
    "id": "auth0|630f8c2b524936fea93c0e75",
    "email": "simple@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.chili-publish.com/",
    "lastSeen": 1668540708,
    "subscriptionRoles": [
      "TD",
      "SA"
    ],
    "isFederated": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.