[comment]: # ({d632e1b8-d632e1b8})
# token.get

[comment]: # ({/d632e1b8-d632e1b8})

[comment]: # ({980bb7e6-980bb7e6})
### Descripció

`integer/array token.get(object parameters)`

El mètode permet recuperar tokens segons els paràmetres donats.

:::noteclassic
Només el tipus d'usuari *Super admin* té permisos per veure els tokens d'altres usuaris.
:::

[comment]: # ({/980bb7e6-980bb7e6})

[comment]: # ({bd09fafb-cc094e72})

### Paràmetres

`(object)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|tokenids|string/array|Retorna només tokens amb els ID donats.|
|userids|string/array|Retorna només els tokens creats per als usuaris donats.|
|token|string|Retorna només els tokens creats per al *token d'autenticació* donat.|
|valid\_at|timestamp|Retorna només tokens vàlids (no caducats) a la data i hora indicades.|
|expired\_at|timestamp|Retorna només els tokens que han caducat (no vàlids) a la data i hora donades.|
|sortfield|string/array|Ordena el resultat segons les propietats donades.<br><br>Els valors possibles són: `tokenid`, `name`, `lastaccess`, `status`, `expires_at` i `created_at `. |
|countOutput|boolean|Aquests paràmetres comuns a tots els mètodes `get` es descriuen en detall a la pàgina [comentaris de referència](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/bd09fafb-cc094e72})

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({f8520490-66760f5f})
#### Recuperar un token

Recuperar tota la informació del token amb ID "2".

[Petició](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "token.get",
    "params": {
        "output": "extend",
        "tokenids": "2"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "tokenid": "1",
            "name": "The Token",
            "description": "",
            "userid": "1",
            "lastaccess": "0",
            "status": "0",
            "expires_at": "1609406220",
            "created_at": "1611239454",
            "creator_userid": "1"
        }
    ],
    "id": 1
}
```

[comment]: # ({/f8520490-66760f5f})

[comment]: # ({5cf2ab45-5cf2ab45})
### Font

CToken::get() in *ui/include/classes/api/services/CToken.php*.

[comment]: # ({/5cf2ab45-5cf2ab45})