List users

Request

List users of a specific TMC or a company.

Security

Bearer

Bodyapplication/jsonrequired

One of:

TMC ID

userStatusFilterstring

Retrieve active, inactive, or all users.

Default:"ACTIVE"

Enum:"ACTIVE""INACTIVE""ALL"

Example:"INACTIVE"

searchTextstring

Query text to search users. The match would be case-insensitive.

Example:"chi"

paginationobject(OffsetBasedPaginationRequestParams)required

Pagination parameters for requests.

filtersArray of objects(UserListFilter)

Filters to refine the list of users returned. Users matching with any of the filters would be returned.

regionstring

Optional region filter to fetch user data from non US regions.

Example:"DE"

includeApiUsersboolean

Whether to include API users in the results.

Default:false

Example:true

sortobject(UserSort)

tmcIdobject(EntityId)required

TMC ID

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/users/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tmcId": {
      "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
    },
    "userStatusFilter": "INACTIVE",
    "searchText": "chi",
    "pagination": {
      "offset": 0,
      "limit": 100
    },
    "filters": [
      {
        "legalEntityIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "officeIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "departmentIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "costCenterIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "userIds": [
          {
            "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
          }
        ],
        "emails": [
          "string"
        ],
        "externalIds": [
          "string"
        ],
        "personas": [
          "EMPLOYEE"
        ],
        "roles": [
          "TRAVEL_ARRANGER"
        ],
        "designations": [
          "string"
        ],
        "tiers": [
          "SEAT1A"
        ]
      }
    ],
    "region": "DE",
    "includeApiUsers": true,
    "sort": {
      "sortBy": "NAME",
      "sortOrder": "DESCENDING"
    }
  }'

Responses

OK

Bodyapplication/json

usersArray of objects(UserDetail)

Users matching the filters specified in the request.

paginationobject(PaginationResponseParams)

Pagination parameters for response.

Response

{
  "users": [
    { … }
  ],
  "pagination": {
    "totalNumResults": 0
  }
}