Skip to main content

Current user

These endpoints tell you who the token belongs to and which company accounts (directoryId) it can address. Most integrations call them first.

Every endpoint below shows its parameters and response fields in the middle and a request sample with an example response on the right.

Base URL https://api.sally.ioVersion v1.0 current, not frozen yetHow versioning works

Returns the basic info of the authenticated user​

GET/v1.0/me
Field overview from the specification

Response fields:

  • userId (string): unique user id.
  • email (string): email address of the user.
  • firstName (string): first name.
  • lastName (string): last name.
  • timeZone (string | null): IANA time zone identifier of the user (e.g. "Europe/Berlin"), suitable for Intl.DateTimeFormat and date math. Null if the user has no time zone set.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: email, firstName, lastName, timeZone, userId.

    Example: email,firstName

Response

  • userIdstringrequired

    Unique user id.

  • emailstringrequired

    Email address of the user.

  • firstNamestringrequired

    First name.

  • lastNamestringrequired

    Last name.

  • timeZonestringrequirednullable

    IANA time zone identifier of the user (e.g. "Europe/Berlin"), suitable for Intl.DateTimeFormat and date math. Null if the user has no time zone set.

Status codes

  • 200Success
  • 401

    Missing or invalid bearer token.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Lists the memberships of the authenticated user across all directories​

GET/v1.0/me/directories/memberships

Discovery of "which directories + my role/license in each". Resolve roleId/licenseId via GET /v1.0/roles / GET /v1.0/licenses.

Field overview from the specification

Each item has:

  • directoryId (string): id of the directory.
  • directoryName (string): display name of the directory.
  • roleId (string): role id of the caller in this directory; resolve via GET /v1.0/roles.
  • licenseId (string): license id of the caller in this directory; resolve via GET /v1.0/licenses.
  • isBlocked (boolean): whether the caller is blocked in this directory.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: directoryId, directoryName, isBlocked, licenseId, roleId.

    Example: directoryId,directoryName

Response

  • directoryIdstringrequired

    Id of the directory.

  • directoryNamestringrequired

    Display name of the directory.

  • roleIdstringrequired

    Role id of the caller in this directory. Resolve via GET /v1.0/roles.

  • licenseIdstringrequired

    License id of the caller in this directory. Resolve via GET /v1.0/licenses.

  • isBlockedbooleanrequired

    Whether the caller is blocked in this directory.

Status codes

  • 200Success
  • 401

    Missing or invalid bearer token.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.