SMsmartling
People

List and filter account users

Changed on

Beta. This endpoint is available for early use and is not yet covered by our stability commitment for generally available APIs. We may change it based on feedback, including changes that are not backward compatible. We will announce changes in the release notes and notify affected customers at least 30 days in advance.

Returns a page of users in the account matching the given filter. All filter fields are optional.

Callers whose highest role is workflow-level and who belong to an agency see only the users of that agency, regardless of the request. sourceLocales, targetLocales, workflowUid, and workflowStepUids apply only to workflow-level roles.

Results are paged with offsetToken. The response has no total count.

limit above 20 is not rejected. The response is silently capped at 20 items regardless of the requested value.

post/people-api/v3/accounts/{accountUid}/users

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Request body

keywordstring

Case-insensitive substring match against name and email.

userUidsUserUid[]

Restrict results to these user UIDs.

sourceLocalesLocaleId[]

Restrict results to workflow-ACL-level users assigned to one of these source locales.

targetLocalesLocaleId[]

Restrict results to workflow-ACL-level users assigned to one of these target locales.

workflowUidstring

Workflow unique identifier — 12 lowercase alphanumeric characters.

workflowStepUidsWorkflowStepUid[]

Restrict results to workflow-ACL-level users assigned to one of these workflow steps.

limitinteger

Requested page size. Requests above 20 are not rejected. The response is silently capped at 20 items.

offsetTokenstring

Opaque, server-generated pagination cursor. Do not attempt to parse or construct one. Pass back exactly what a previous response returned.

Example request

{
  "userUids": [
    "99b0662fbae1"
  ],
  "sourceLocales": [
    "fr-FR"
  ],
  "targetLocales": [
    "fr-FR"
  ],
  "workflowUid": "5449a8595ae4",
  "workflowStepUids": [
    "7564fc097a85"
  ],
  "offsetToken": "A62623439C40319E167275B10FC30F80D55372C4F932C915E720E9F357DE89A4"
}

Response

Users retrieved.

Example response

{
  "response": {
    "data": {
      "offsetToken": "A62623439C40319E167275B10FC30F80D55372C4F932C915E720E9F357DE89A4",
      "items": [
        {
          "userUid": "99b0662fbae1",
          "lastLogin": "2026-01-15T10:00:00Z",
          "agency": {
            "agencyUid": "f965c52b"
          },
          "localePairs": [
            {
              "sourceLocaleId": "fr-FR",
              "targetLocaleIds": [
                "fr-FR"
              ]
            }
          ]
        }
      ]
    }
  }
}

Changes