---
title: "Read one badgeaward by external identifier"
description: "\n\n### Quire permissions\n\nRequired capability: `badge/manage`.\n\nCredential scopes: `certificates:read`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › certificates

`GET /badge_awards/ext:{external_id}`

\### Quire permissions

Required capability: `badge/manage`.

Credential scopes: `certificates:read`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `certificates:read`
- `oauth2`, oauth2, scopes: `certificates:read`

## Path parameters

- `getBadgeAwardByExternalId.path.external_id` (string, required) — The external identifier, unique per tenant per type, as supplied by the system of record.

## Header parameters

- `getBadgeAwardByExternalId.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://your-organisation.quirelms.com/api/v1/badge_awards/ext:string \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/badge_awards/ext:string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/badge_awards/ext:string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "badge_class_id": "string",
  "user_id": "string",
  "state": "string",
  "issued_at": "string",
  "expires_at": "string",
  "verification_uid": "string",
  "revoked_at": "string",
  "created_at": "string",
  "updated_at": "string"
}
```

- `getBadgeAwardByExternalId.response.200.id` (string, required)
- `getBadgeAwardByExternalId.response.200.external_id` (string | null, required)
- `getBadgeAwardByExternalId.response.200.badge_class_id` (string, required)
- `getBadgeAwardByExternalId.response.200.user_id` (string, required)
- `getBadgeAwardByExternalId.response.200.state` (string, required)
- `getBadgeAwardByExternalId.response.200.issued_at` (string, required) — RFC 3339 timestamp in UTC.
- `getBadgeAwardByExternalId.response.200.expires_at` (any of, required)
  - any of: `string`, `null`
- `getBadgeAwardByExternalId.response.200.verification_uid` (string, required)
- `getBadgeAwardByExternalId.response.200.revoked_at` (any of, required)
  - any of: `string`, `null`
- `getBadgeAwardByExternalId.response.200.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `getBadgeAwardByExternalId.response.200.updated_at` (string, required) — RFC 3339 timestamp in UTC.

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.401.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.401.title` (string, required)
- `getBadgeAwardByExternalId.response.401.status` (integer, required)
- `getBadgeAwardByExternalId.response.401.code` (string, required)
- `getBadgeAwardByExternalId.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.401.detail` (string, required)
- `getBadgeAwardByExternalId.response.401.request_id` (string, required)
- `getBadgeAwardByExternalId.response.401.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.401.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.401.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.401.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.403.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.403.title` (string, required)
- `getBadgeAwardByExternalId.response.403.status` (integer, required)
- `getBadgeAwardByExternalId.response.403.code` (string, required)
- `getBadgeAwardByExternalId.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.403.detail` (string, required)
- `getBadgeAwardByExternalId.response.403.request_id` (string, required)
- `getBadgeAwardByExternalId.response.403.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.403.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.403.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.403.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.403.retry_after` (integer | null, optional)

### 404

No such resource, or none this credential is permitted to know about.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.404.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.404.title` (string, required)
- `getBadgeAwardByExternalId.response.404.status` (integer, required)
- `getBadgeAwardByExternalId.response.404.code` (string, required)
- `getBadgeAwardByExternalId.response.404.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.404.detail` (string, required)
- `getBadgeAwardByExternalId.response.404.request_id` (string, required)
- `getBadgeAwardByExternalId.response.404.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.404.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.404.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.404.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.404.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.404.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.422.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.422.title` (string, required)
- `getBadgeAwardByExternalId.response.422.status` (integer, required)
- `getBadgeAwardByExternalId.response.422.code` (string, required)
- `getBadgeAwardByExternalId.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.422.detail` (string, required)
- `getBadgeAwardByExternalId.response.422.request_id` (string, required)
- `getBadgeAwardByExternalId.response.422.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.422.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.422.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.422.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.429.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.429.title` (string, required)
- `getBadgeAwardByExternalId.response.429.status` (integer, required)
- `getBadgeAwardByExternalId.response.429.code` (string, required)
- `getBadgeAwardByExternalId.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.429.detail` (string, required)
- `getBadgeAwardByExternalId.response.429.request_id` (string, required)
- `getBadgeAwardByExternalId.response.429.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.429.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.429.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.429.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getBadgeAwardByExternalId.response.500.type` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.500.title` (string, required)
- `getBadgeAwardByExternalId.response.500.status` (integer, required)
- `getBadgeAwardByExternalId.response.500.code` (string, required)
- `getBadgeAwardByExternalId.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getBadgeAwardByExternalId.response.500.detail` (string, required)
- `getBadgeAwardByExternalId.response.500.request_id` (string, required)
- `getBadgeAwardByExternalId.response.500.docs_url` (string, required)
  - format `uri`
- `getBadgeAwardByExternalId.response.500.errors` (array<object>, optional)
  - `getBadgeAwardByExternalId.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getBadgeAwardByExternalId.response.500.errors.code` (string, required)
  - `getBadgeAwardByExternalId.response.500.errors.detail` (string, required)
- `getBadgeAwardByExternalId.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/certificates/getBadgeAwardByExternalId/index.md