Descubrir usuarios conectados

Devuelve los usuarios conectados a tu aplicación mediante otorgamientos OAuth activos, con el externalReferenceId y los alcances concedidos para cada uno. Úsalo para ver a quién puedes dirigir y qué ha autorizado cada usuario antes de llamar a otras operaciones masivas. Devuelve únicamente identificadores y alcances concedidos — nunca tokens de usuario.

Requisitos

Authorization: Basic <API_KEY> (la clave de API de tu aplicación)
La capacidad de API masiva en tu aplicación

Consulta

query GetBulkConnectedOAuthUsers($paginate: BulkPaginationInput) {
  getBulkConnectedOAuthUsers(paginate: $paginate) {
    totalCount
    hasNextPage
    users {
      externalReferenceId
      accountId
      userId
      scopes
      connectedAt
    }
  }
}

Variables

{
  "paginate": { "limit": 100, "offset": 0 }
}

Respuesta

{
  "data": {
    "getBulkConnectedOAuthUsers": {
      "totalCount": 128,
      "hasNextPage": true,
      "users": [
        {
          "externalReferenceId": "your-user-001",
          "accountId": "8f3c…",
          "userId": "b21a…",
          "scopes": ["LIST_PAYMENT", "LIST_PURCHASES"],
          "connectedAt": "2026-05-01T12:00:00.000Z"
        }
      ]
    }
  }
}

Argumentos

Argumento	Tipo	Descripción
`paginate.limit`	`Int`	Usuarios por página. El máximo y el predeterminado son 100.
`paginate.offset`	`Int`	Número de usuarios a omitir. El valor predeterminado es `0`.

Campos de respuesta

Campo	Descripción
`users[].externalReferenceId`	Tu id de referencia para el usuario. `null` si no se estableció al momento de la conexión — dichos usuarios solo se pueden alcanzar vía `ALL_CONNECTED`.
`users[].accountId`	El id de cuenta del usuario conectado.
`users[].userId`	El id de usuario del usuario conectado.
`users[].scopes`	Alcances que el usuario concedió a tu aplicación.
`users[].connectedAt`	Cuándo se conectó el usuario.
`totalCount`	Total de usuarios conectados en todas las páginas.
`hasNextPage`	Si existen más usuarios más allá de esta página.

Notas

La API masiva permite páginas más grandes que el resto de la API — hasta 100 por página.
Pagina con offset hasta que hasNextPage sea false.

​Requisitos

​Consulta

​Variables

​Respuesta

​Argumentos

​Campos de respuesta

​Notas