API reference
Every v1 API endpoint, generated from the same code that answers requests. Download the OpenAPI 3.1 specification to generate a client.
List members
get /members
Returns the company's members, newest first.
Scope: members:read
Parameters
| Name | Type | Description |
|---|---|---|
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor returned as next_cursor by the previous page. |
role query | "owner" | "admin" | "manager" | "member" | Filter by role. |
email query | string (email) | Filter by exact email. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | Member[] | |
has_more required | boolean | |
next_cursor required | string | null |
Invite a member
post /members
Sends an email invitation. The invitation holds a seat until it expires. Emits member.invited.
Scope: members:write
Parameters
| Name | Type | Description |
|---|---|---|
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Request body
| Name | Type | Description |
|---|---|---|
email required | string (email) | Email of the person to invite. |
role | "admin" | "manager" | "member" | Role in the company. |
Response 201
| Name | Type | Description |
|---|---|---|
id | string | |
object | "invitation" | |
email | string (email) | |
role | "admin" | "manager" | "member" | |
status | "pending" | |
expires_at | string (date-time) | |
created_at | string (date-time) |
Retrieve a member
get /members/{id}
Returns one member of the company.
Scope: members:read
Parameters
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "member" | |
user_id | string | |
name | string | |
email | string (email) | |
role | "owner" | "admin" | "manager" | "member" | |
status | "active" | "disabled" | |
created_at | string (date-time) |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | string | |
deleted | true |
Company seats
get /seats
Seats purchased, used, held by pending invitations, and available.
Scope: members:read
Parameters
| Name | Type | Description |
|---|---|---|
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
object | "seats" | |
purchased | integer | |
used | integer | |
pending | integer | Pending invitations holding a seat. |
available | integer |
List tags
get /tags
Returns the company's tags. With a test key it returns only demo tags.
Scope: tags:read
Parameters
| Name | Type | Description |
|---|---|---|
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor returned as next_cursor by the previous page. |
status query | "in_stock" | "assigned" | "active" | "lost" | "deactivated" | Filter by status. |
member query | string | Filter by assigned member. |
product query | string | Filter by product. |
product_type query | "keychain" | "display" | "plate" | "totem" | "gadget" | "other" | Filter by product type. |
code query | string | Filter by printed code. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | Tag[] | |
has_more required | boolean | |
next_cursor required | string | null |
Retrieve a tag
get /tags/{id}
Returns one of the company's tags.
Scope: tags:read
Parameters
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "tag" | |
code | string | 8-character code printed on the tag. |
url | string (uri) | Fixed URL written in the chip. |
email_address | string (email) | The tag's unique address for the email action. |
chip_type | "ntag213" | "ntag215" | "ntag216" | "ntag424" | |
status | "in_stock" | "assigned" | "active" | "lost" | "deactivated" | |
product | object | null | |
member_id | string | null | |
action_id | string | null | |
location | Location | null | The tag's place, or its product's when the tag has none. |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Request body
| Name | Type | Description |
|---|---|---|
member_id | string | null | Member to assign the tag to. |
action_id | string | null | Action run on scan. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "tag" | |
code | string | 8-character code printed on the tag. |
url | string (uri) | Fixed URL written in the chip. |
email_address | string (email) | The tag's unique address for the email action. |
chip_type | "ntag213" | "ntag215" | "ntag216" | "ntag424" | |
status | "in_stock" | "assigned" | "active" | "lost" | "deactivated" | |
product | object | null | |
member_id | string | null | |
action_id | string | null | |
location | Location | null | The tag's place, or its product's when the tag has none. |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "tag" | |
code | string | 8-character code printed on the tag. |
url | string (uri) | Fixed URL written in the chip. |
email_address | string (email) | The tag's unique address for the email action. |
chip_type | "ntag213" | "ntag215" | "ntag216" | "ntag424" | |
status | "in_stock" | "assigned" | "active" | "lost" | "deactivated" | |
product | object | null | |
member_id | string | null | |
action_id | string | null | |
location | Location | null | The tag's place, or its product's when the tag has none. |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
List actions
get /actions
Actions configured in the company, to use as a tag's action_id.
Scope: tags:read
Parameters
| Name | Type | Description |
|---|---|---|
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor returned as next_cursor by the previous page. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | Action[] | |
has_more required | boolean | |
next_cursor required | string | null |
List scans
get /scans
Recorded scans, newest first. Filter by period, tag, member and outcome.
Scope: scans:read
Parameters
| Name | Type | Description |
|---|---|---|
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor returned as next_cursor by the previous page. |
from query | string (date-time) | From this instant (inclusive), ISO 8601. |
to query | string (date-time) | Until this instant (exclusive), ISO 8601. |
tag query | string | Filter by tag. |
member query | string | Filter 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
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | Scan[] | |
has_more required | boolean | |
next_cursor required | string | null |
List webhook endpoints
get /webhooks
Endpoints in the key's mode (live or test).
Scope: webhooks:write
Parameters
| Name | Type | Description |
|---|---|---|
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor returned as next_cursor by the previous page. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | WebhookEndpoint[] | |
has_more required | boolean | |
next_cursor required | string | null |
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
| Name | Type | Description |
|---|---|---|
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Request body
| Name | Type | Description |
|---|---|---|
url required | string (uri) | Public https URL that receives events. |
enabled_events required | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | Events to receive; "*" for all. |
description | string | null |
Response 201
| Name | Type | Description |
|---|---|---|
id | string | |
object | "webhook_endpoint" | |
url | string (uri) | |
description | string | null | |
enabled_events | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | |
status | "enabled" | "disabled" | |
disabled_reason | string | null | |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) | |
secret | string | whsec_… signing secret: shown only now. |
Retrieve a webhook endpoint
get /webhooks/{id}
Returns one webhook endpoint.
Scope: webhooks:write
Parameters
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "webhook_endpoint" | |
url | string (uri) | |
description | string | null | |
enabled_events | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | |
status | "enabled" | "disabled" | |
disabled_reason | string | null | |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Request body
| Name | Type | Description |
|---|---|---|
url | string (uri) | Public https URL that receives events. |
enabled_events | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | Events to receive; "*" for all. |
description | string | null | |
status | "enabled" | "disabled" |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "webhook_endpoint" | |
url | string (uri) | |
description | string | null | |
enabled_events | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | |
status | "enabled" | "disabled" | |
disabled_reason | string | null | |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) |
Delete a webhook endpoint
delete /webhooks/{id}
Deletes the endpoint and its delivery log. Queued retries stop.
Scope: webhooks:write
Parameters
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | string | |
deleted | true |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Request body
| Name | Type | Description |
|---|---|---|
expire_previous_in_hours | integer | Hours the previous secret stays valid. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "webhook_endpoint" | |
url | string (uri) | |
description | string | null | |
enabled_events | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "*"[] | |
status | "enabled" | "disabled" | |
disabled_reason | string | null | |
livemode | boolean | |
created_at | string (date-time) | |
updated_at | string (date-time) | |
secret | string | whsec_… signing secret: shown only now. |
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
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
TapLogic-Version header | "2026-11-18" | API version (date). Without it, the latest applies. |
Idempotency-Key header | string | Unique key to retry a write without duplicating it. Valid for 24 hours. |
Response 200
| Name | Type | Description |
|---|---|---|
id | string | |
object | "webhook_delivery" | |
endpoint_id | string | |
event_id | string | |
event_type | "tag.scanned" | "tag.assigned" | "member.invited" | "member.joined" | "webhook.test" | |
attempt | integer | |
status | "pending" | "succeeded" | "failed" | |
response_status | integer | null | |
duration_ms | integer | null | |
error | string | null | |
next_retry_at | string (date-time) | null | |
created_at | string (date-time) |
Delivery log
get /webhooks/{id}/deliveries
Every delivery attempt for the endpoint, newest first, with HTTP status, duration and error.
Scope: webhooks:write
Parameters
| Name | Type | Description |
|---|---|---|
id path | string | Resource identifier. |
limit query | integer | Items per page (1–100). |
cursor query | string | Cursor 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
| Name | Type | Description |
|---|---|---|
object required | "list" | |
data required | WebhookDelivery[] | |
has_more required | boolean | |
next_cursor required | string | null |