OpenAPI reference
Receiver Tokens
/tokens/{country_code}/{party_id}/{token_uid}Retrieve a Token as it is stored in the CPO system.
API: OCPI 2.1.1 (CPO) · Module: Tokens (CPO)
Base path:/tokens· Base URL:https://ocpi-api.gridos.co/ocpi/cpo/2.1.1
Overview
GET /tokens/{country_code}/{party_id}/{token_uid}Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}
Retrieve a Token as it is stored in the CPO system.
Requires authentication. Use Authorization: Token <token>. See OCPI credentials.
How to call
Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.
curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
-H "Authorization: Token $OCPI_TOKEN"Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
country_code | string | Yes | ISO-3166 alpha-2 country code of the party performing this request. |
party_id | string | Yes | 3-char party ID of the CPO or eMSP (ISO-15118). |
token_uid | string | Yes | Token.uid of the Token. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | TokenType | No | Token.type of the Token, defaults to RFID if not provided. |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Response | OneTokenResponse |
401 | Unauthorized | — |
404 | Not Found | — |
422 | Validation Error | HTTPValidationError |
200 — successful response
application/json
Schema: OneTokenResponse
| Field | Type | Required | Description |
|---|---|---|---|
status_code | integer | No | Default: 1000 |
status_message | string | No | — |
timestamp | string (date-time) | No | — |
data | Token | No | Token |
Response example
{
"status_code": 1000,
"status_message": "Success",
"timestamp": "2015-06-29T22:39:09Z",
"data": {
"auth_id": "DE8ACC12E46L89",
"issuer": "TheNewMotion",
"language": "en",
"last_updated": "2015-06-29T22:39:09Z",
"type": "RFID",
"uid": "012345678",
"valid": true,
"visual_number": "DF000-2001-8999",
"whitelist": "ALLOWED"
}
}401 — unauthorized
application/json
Response example
{
"status_code": 2000,
"status_message": "Unauthorized",
"timestamp": "2025-01-01T00:00:00Z"
}404 — not found
application/json
Response example
{
"status_code": 2004,
"status_message": "Resource not found",
"timestamp": "2025-01-01T00:00:00Z"
}422 — validation error
application/json
Schema: HTTPValidationError
| Field | Type | Required | Description |
|---|---|---|---|
detail | ValidationError[] | No | Detail |
Response example
{
"detail": [
{
"loc": [],
"msg": "string",
"type": "string",
"input": {
"_type": "Input"
},
"ctx": {
"_type": "Context"
}
}
]
}Examples
Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).
curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
-H "Authorization: Token $OCPI_TOKEN"