Skip to content
TapLogic API
Italiano

API reference

Every v1 API endpoint, generated from the same code that answers requests. Download the OpenAPI 3.1 specification to generate a client.

OpenAPI specification (JSON)

List members

get /members

Returns the company's members, newest first.

Scope: members:read

Parameters

NameTypeDescription
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
role query"owner" | "admin" | "manager" | "member"Filter by role.
email querystring (email)Filter by exact email.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredMember[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Invite a member

post /members

Sends an email invitation. The invitation holds a seat until it expires. Emits member.invited.

Scope: members:write

Parameters

NameTypeDescription
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Request body

NameTypeDescription
email requiredstring (email)Email of the person to invite.
role"admin" | "manager" | "member"Role in the company.

Response 201

NameTypeDescription
idstring
object"invitation"
emailstring (email)
role"admin" | "manager" | "member"
status"pending"
expires_atstring (date-time)
created_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Retrieve a member

get /members/{id}

Returns one member of the company.

Scope: members:read

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
idstring
object"member"
user_idstring
namestring
emailstring (email)
role"owner" | "admin" | "manager" | "member"
status"active" | "disabled"
created_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Remove a member

delete /members/{id}

Removes the person from the company and frees the seat. Their tags stay without a member.

Scope: members:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Response 200

NameTypeDescription
idstring
objectstring
deletedtrue
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Company seats

get /seats

Seats purchased, used, held by pending invitations, and available.

Scope: members:read

Parameters

NameTypeDescription
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object"seats"
purchasedinteger
usedinteger
pendingintegerPending invitations holding a seat.
availableinteger
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

List tags

get /tags

Returns the company's tags. With a test key it returns only demo tags.

Scope: tags:read

Parameters

NameTypeDescription
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
status query"in_stock" | "assigned" | "active" | "lost" | "deactivated"Filter by status.
member querystringFilter by assigned member.
product querystringFilter by product.
product_type query"keychain" | "display" | "plate" | "totem" | "gadget" | "other"Filter by product type.
code querystringFilter by printed code.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredTag[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Retrieve a tag

get /tags/{id}

Returns one of the company's tags.

Scope: tags:read

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
idstring
object"tag"
codestring8-character code printed on the tag.
urlstring (uri)Fixed URL written in the chip.
email_addressstring (email)The tag's unique address for the email action.
chip_type"ntag213" | "ntag215" | "ntag216" | "ntag424"
status"in_stock" | "assigned" | "active" | "lost" | "deactivated"
productobject | null
member_idstring | null
action_idstring | null
locationLocation | nullThe tag's place, or its product's when the tag has none.
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Assign a tag or set its action

patch /tags/{id}

Assigns the tag to a member (member_id) and/or sets the scan action (action_id). null clears the value. A member change emits tag.assigned.

Scope: tags:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Request body

NameTypeDescription
member_idstring | nullMember to assign the tag to.
action_idstring | nullAction run on scan.

Response 200

NameTypeDescription
idstring
object"tag"
codestring8-character code printed on the tag.
urlstring (uri)Fixed URL written in the chip.
email_addressstring (email)The tag's unique address for the email action.
chip_type"ntag213" | "ntag215" | "ntag216" | "ntag424"
status"in_stock" | "assigned" | "active" | "lost" | "deactivated"
productobject | null
member_idstring | null
action_idstring | null
locationLocation | nullThe tag's place, or its product's when the tag has none.
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Deactivate a tag

post /tags/{id}/deactivate

The tag stops running actions: a scan shows a neutral page. This is final through the API.

Scope: tags:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Response 200

NameTypeDescription
idstring
object"tag"
codestring8-character code printed on the tag.
urlstring (uri)Fixed URL written in the chip.
email_addressstring (email)The tag's unique address for the email action.
chip_type"ntag213" | "ntag215" | "ntag216" | "ntag424"
status"in_stock" | "assigned" | "active" | "lost" | "deactivated"
productobject | null
member_idstring | null
action_idstring | null
locationLocation | nullThe tag's place, or its product's when the tag has none.
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

List actions

get /actions

Actions configured in the company, to use as a tag's action_id.

Scope: tags:read

Parameters

NameTypeDescription
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredAction[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

List scans

get /scans

Recorded scans, newest first. Filter by period, tag, member and outcome.

Scope: scans:read

Parameters

NameTypeDescription
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
from querystring (date-time)From this instant (inclusive), ISO 8601.
to querystring (date-time)Until this instant (exclusive), ISO 8601.
tag querystringFilter by tag.
member querystringFilter by member.
outcome query"ok" | "tag_deactivated" | "tag_unknown" | "invalid_signature"Filter by outcome.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredScan[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

List webhook endpoints

get /webhooks

Endpoints in the key's mode (live or test).

Scope: webhooks:write

Parameters

NameTypeDescription
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredWebhookEndpoint[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Create a webhook endpoint

post /webhooks

Registers a URL that receives signed events. The signing secret appears only in this response.

Scope: webhooks:write

Parameters

NameTypeDescription
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Request body

NameTypeDescription
url requiredstring (uri)Public https URL that receives events.
enabled_events required"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]Events to receive; "*" for all.
descriptionstring | null

Response 201

NameTypeDescription
idstring
object"webhook_endpoint"
urlstring (uri)
descriptionstring | null
enabled_events"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]
status"enabled" | "disabled"
disabled_reasonstring | null
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
secretstringwhsec_… signing secret: shown only now.
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Retrieve a webhook endpoint

get /webhooks/{id}

Returns one webhook endpoint.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
idstring
object"webhook_endpoint"
urlstring (uri)
descriptionstring | null
enabled_events"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]
status"enabled" | "disabled"
disabled_reasonstring | null
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Update a webhook endpoint

patch /webhooks/{id}

Changes URL, events or description. status=enabled re-enables a disabled endpoint and resets its errors.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Request body

NameTypeDescription
urlstring (uri)Public https URL that receives events.
enabled_events"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]Events to receive; "*" for all.
descriptionstring | null
status"enabled" | "disabled"

Response 200

NameTypeDescription
idstring
object"webhook_endpoint"
urlstring (uri)
descriptionstring | null
enabled_events"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]
status"enabled" | "disabled"
disabled_reasonstring | null
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Delete a webhook endpoint

delete /webhooks/{id}

Deletes the endpoint and its delivery log. Queued retries stop.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Response 200

NameTypeDescription
idstring
objectstring
deletedtrue
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Rotate the signing secret

post /webhooks/{id}/rotate-secret

Creates a new secret. The old one stays valid for expire_previous_in_hours hours (default 24, 0 = now): meanwhile each event carries two v1 signatures.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Request body

NameTypeDescription
expire_previous_in_hoursintegerHours the previous secret stays valid.

Response 200

NameTypeDescription
idstring
object"webhook_endpoint"
urlstring (uri)
descriptionstring | null
enabled_events"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[]
status"enabled" | "disabled"
disabled_reasonstring | null
livemodeboolean
created_atstring (date-time)
updated_atstring (date-time)
secretstringwhsec_… signing secret: shown only now.
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Send a test event

post /webhooks/{id}/test

Sends a signed webhook.test event now and returns the delivery result. No retries.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.
Idempotency-Key headerstringUnique key to retry a write without duplicating it. Valid for 24 hours.

Response 200

NameTypeDescription
idstring
object"webhook_delivery"
endpoint_idstring
event_idstring
event_type"tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "webhook.test"
attemptinteger
status"pending" | "succeeded" | "failed"
response_statusinteger | null
duration_msinteger | null
errorstring | null
next_retry_atstring (date-time) | null
created_atstring (date-time)
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.

Delivery log

get /webhooks/{id}/deliveries

Every delivery attempt for the endpoint, newest first, with HTTP status, duration and error.

Scope: webhooks:write

Parameters

NameTypeDescription
id pathstringResource identifier.
limit queryintegerItems per page (1–100).
cursor querystringCursor returned as next_cursor by the previous page.
status query"pending" | "succeeded" | "failed"
TapLogic-Version header"2026-11-18"API version (date). Without it, the latest applies.

Response 200

NameTypeDescription
object required"list"
data requiredWebhookDelivery[]
has_more requiredboolean
next_cursor requiredstring | null
Try it
Use a tl_test_ key. It stays on this page and goes only to api.taplogic.it.