Sign in

v1

latestOpenAPI 3.1.02026-08-062713899.5 KB
Users

List users

List users of a specific TMC or a company.

post/v3/users/list

Request body

OR

Example request

{
  "tmcId": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
  },
  "userStatusFilter": "INACTIVE",
  "searchText": "chi",
  "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"
        }
      ],
      "personas": [
        "EMPLOYEE"
      ],
      "roles": [
        "TRAVEL_ARRANGER"
      ],
      "tiers": [
        "SEAT1A"
      ]
    }
  ],
  "region": "DE",
  "sort": {
    "sortBy": "NAME",
    "sortOrder": "DESCENDING"
  }
}

Response

OK

Example response

{
  "users": [
    {
      "organization": {
        "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
        "name": "Name"
      },
      "persona": "EMPLOYEE",
      "personalDetail": {
        "name": {
          "family1": "Gandas",
          "family2": "FamilyTwo",
          "given": "Vichitr",
          "middle": "Kumar",
          "suffix": "SR",
          "preferred": "Don"
        },
        "title": "MR",
        "gender": "FEMALE",
        "pronoun": "SHE_HER_HERS",
        "profilePicture": {
          "data": "6935813e12584abda0e43d71cd2ea260",
          "dimensions": {
            "height": 120,
            "width": 240
          },
          "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp"
        }
      },
      "businessDetail": {
        "legalEntity": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "office": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "department": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        },
        "costCenter": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "createdAt": {
        "iso8601": "2017-07-21T17:32"
      },
      "lastUpdatedAt": {
        "iso8601": "2017-07-21T17:32"
      }
    }
  ]
}