Label Management

Get Label Assignment

Get a specific label assignment by ID. Returns 404 if the ID does not exist or belongs to another organization.

get/v0/platform/labels/{id}

Request

Base URL
https://api.blockaid.io
Auth
- API key in header X-API-Key
- or API key in header X-CLIENT-ID
TypeScript
https://skmtc.dev/blockaid-official/apis/blockaid-api/docs/v0/platform/labels/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Label assignment ID.

The unique ID (uuid) of the label assignment, as returned in the id field of an apply / list / search response.

Label assignment retrieved

idstring uuid required

Unique ID of this label assignment.

identifierstring required

The labeled address, domain or token.

identifier_type'address' | 'domain' | 'token' required

The type of the labeled identifier.

chainstring nullable required

The chain this label applies to. null means the label applies to ALL chains (sticky); chain is always null for domains, which are not chain-scoped.

labelstring required

The applied label name.

result_type'Malicious' | 'Benign' required

Whether this label marks the entity as Malicious (block) or Benign (allow). Derived from the label.

tagsstring[] required

Tags grouping this label.

commentstring nullable

Free-text note explaining the label, if any.

created_bystring required

Who created the assignment (e.g. "API" or a user identifier).

updated_bystring required

Who last updated the assignment.

created_atstring date-time required

Creation timestamp (ISO 8601, UTC).

updated_atstring date-time required

Last-update timestamp (ISO 8601, UTC).