internalUsers

This query loads the basic information of the internal users within an organization.

General Pattern

query{
    internalUser(organizationID: "UUID"){
    field_1
    field_2 {
       nested_field_1
       ...
    }
  }
}

Sample Query

query{
  internalUsers(organizationID:"a1dc174d-abf4-47d3-be3c-9281c6eba456"){
    id
    userId
    user{
      id
      username
      name
      email
    }
    externalUserId
    organizationId
    kycStatus
    role
    bidAllowed
    username
    avatar
    settings
  }
}

Sample Response

{
  "data": {
    "internalUsers": [
      {
        "id": "4b77b59e-63a2-4d92-a5c7-efdd077a2eaf",
        "userId": "b090f54b-0d6d-4d7a-9039-00bcfd0e5725",
        "user": {
          "id": "b090f54b-0d6d-4d7a-9039-00bcfd0e5725",
          "username": "9b8337a8-cefa-41a9-8215-52e3d1fe5540",
          "name": "dan",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "5fc98be8-5f66-473c-a045-265be82dd123",
        "userId": "8fb5641f-8f51-4eb0-ac35-de9779813723",
        "user": {
          "id": "8fb5641f-8f51-4eb0-ac35-de9779813723",
          "username": "1f12cada-9b42-438d-8a30-71266cbe9990",
          "name": "artem",
          "email": "[email protected]"
        },
        "externalUserId": "[email protected]",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": true,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "14fc45f0-fd58-4ac6-83ab-99b4b1be4ff8",
        "userId": "69d4e258-371c-4475-b038-6c6d1a775a2f",
        "user": {
          "id": "69d4e258-371c-4475-b038-6c6d1a775a2f",
          "username": "9629ad4c-fa0e-442b-a8d1-20f6af2aecf1",
          "name": "filip",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "6372131d-d94a-47a4-9d6c-438bbc3b80c3",
        "userId": "8788a820-d8db-4af0-9338-0e2493241fde",
        "user": {
          "id": "8788a820-d8db-4af0-9338-0e2493241fde",
          "username": "482e8885-f4f8-43e2-b29f-f56b4792c3ad",
          "name": "peter",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "bf1ecb66-64fe-4197-b920-0ec842d4acca",
        "userId": "8bff118f-ffa5-4db5-badb-649b629225ca",
        "user": {
          "id": "8bff118f-ffa5-4db5-badb-649b629225ca",
          "username": "96457ff3-f059-46b3-bfc4-25f82123f8bd",
          "name": "fernando.rosenblit",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": true,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "dcea828a-b43a-4f0e-8dc9-2e4c60549fb3",
        "userId": "21414c2e-645f-4006-a2b4-3d40de1d21d2",
        "user": {
          "id": "21414c2e-645f-4006-a2b4-3d40de1d21d2",
          "username": "482aa96b-ae6d-435e-9469-40e2d03aaf3d",
          "name": "frederick.bejarano",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "3348b1d5-e1f0-4ad9-b356-a59907cfc6bc",
        "userId": "ea61ae94-8e7c-47b2-86ac-2f75c2896938",
        "user": {
          "id": "ea61ae94-8e7c-47b2-86ac-2f75c2896938",
          "username": "d2c0a9cf-4456-4956-af92-a523b13aba6b",
          "name": "veljko",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|114968722505504119145",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "66cb3eeb-84fd-4d9b-9e3e-7e1e647595cc",
        "userId": "dd5a914b-ec03-4236-b95f-07e97e8c2e40",
        "user": {
          "id": "dd5a914b-ec03-4236-b95f-07e97e8c2e40",
          "username": "66696fab-6d74-4313-bcc9-7c3fd79f6aac",
          "name": "lucas.raposeiras",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|104389538401128813838",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "",
        "role": "EndUser",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "a54d4c09-667a-400a-92b8-9528e4e3d6d9",
        "userId": "c3d918c7-32cf-4b1b-9b0c-94b522462513",
        "user": {
          "id": "c3d918c7-32cf-4b1b-9b0c-94b522462513",
          "username": "c763e963-bc4c-423c-bafa-8134b122f7e1",
          "name": "alec",
          "email": "al[email protected]"
        },
        "externalUserId": "google-oauth2|118071790449063378272",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "66ab3eeb-84fd-4d9b-9e3e-7e1e648595cf",
        "userId": "3062dffb-db49-4cb7-bb16-05dfbdb1e982",
        "user": {
          "id": "3062dffb-db49-4cb7-bb16-05dfbdb1e982",
          "username": "4a4c5ff2-f5fe-4b0f-b5c8-1eefe8b75d02",
          "name": "dani",
          "email": "[email protected]"
        },
        "externalUserId": "   ",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "78d094ad-7393-447c-9599-ed775bd2dee1",
        "userId": "adb4ab1e-b1ee-4c1c-87b6-ed2a29b64dee",
        "user": {
          "id": "adb4ab1e-b1ee-4c1c-87b6-ed2a29b64dee",
          "username": "626eec47-06bb-4cb9-9a5c-398d50dddd45",
          "name": "veljko+12345",
          "email": "[email protected]"
        },
        "externalUserId": "auth0|62336bd5abc5b5006f58603c",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "016b746c-248f-463f-819a-63f83edd71bc",
        "userId": "0a697cb8-136f-489d-9a9b-26fe3b6ec806",
        "user": {
          "id": "0a697cb8-136f-489d-9a9b-26fe3b6ec806",
          "username": "8b2827b5-a39a-4ffe-becf-bed7396e18f1",
          "name": "nasir",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|109777407675520154503",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "35e81a4b-f6d4-414d-a1c6-175b41c23017",
        "userId": "e1836faf-3c5c-4470-9096-24c6c4f4d400",
        "user": {
          "id": "e1836faf-3c5c-4470-9096-24c6c4f4d400",
          "username": "4a3e706f-4c19-4c60-90cc-2cb0218c223b",
          "name": "cahyo",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|104043476914695308635",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": "https://lh3.googleusercontent.com/a/AATXAJxiEK6sUyCsLHsKANYwZ5Hc135xS2Tf4OvguTSe=s96-c",
        "settings": null
      },
      {
        "id": "62cb6eeb-84fd-4d9b-9e3e-7e1e647595ca",
        "userId": "e0b3ded8-721b-4259-b8fc-cbcdc965a255",
        "user": {
          "id": "e0b3ded8-721b-4259-b8fc-cbcdc965a255",
          "username": "b8be60b4-f938-4440-8076-dc7aeef7ea85",
          "name": "gabriel",
          "email": "[email protected]"
        },
        "externalUserId": "1",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "47658100-5983-46ae-99ae-4ba49d6cbe06",
        "userId": "811d6736-df92-46fc-b9f2-6ef15fd006b3",
        "user": {
          "id": "811d6736-df92-46fc-b9f2-6ef15fd006b3",
          "username": "37e85a00-5d55-4b1e-9a9b-f4cfcdd11bbd",
          "name": "dan.mckinney",
          "email": "[email protected]"
        },
        "externalUserId": "",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "b71007d3-aec6-4e28-b85c-a4adc323f6a1",
        "userId": "dff1b61a-ca01-45ac-ac72-ad7a4010d825",
        "user": {
          "id": "dff1b61a-ca01-45ac-ac72-ad7a4010d825",
          "username": "c9b7749c-030e-48ba-8006-51010e75e0a7",
          "name": "sean",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|117230007862982849608",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      },
      {
        "id": "74556480-ee2a-4a44-8f6f-5dd515b01caa",
        "userId": "1ce183a9-73a1-4df0-9046-f437e03821ee",
        "user": {
          "id": "1ce183a9-73a1-4df0-9046-f437e03821ee",
          "username": "15e511a5-08fe-46bb-b497-f4e2ad12624c",
          "name": "fernando",
          "email": "[email protected]"
        },
        "externalUserId": "google-oauth2|102809844452336552924",
        "organizationId": "a1dc174d-abf4-47d3-be3c-9281c6eba456",
        "kycStatus": "None",
        "role": "Admin",
        "bidAllowed": false,
        "username": null,
        "avatar": null,
        "settings": null
      }
    ]
  }
}

Argument

NameTypeDescription
organizationIDUUIDThe organization ID.

Fields

NameTypeDescription
UserOrganizationObjectAn object that contains all information about UserOrganization, such as external user ID, KYC status, avatar, and so on.

Example

Load the internal users by the organization ID: