> For the complete documentation index, see [llms.txt](https://help.recart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.recart.com/developers/public-api/optin-tool/receive-a-single-opt-in-tool.md).

# Receive a single opt-in tool

Get opt-in tool by ID

```json
{"openapi":"3.1.0","info":{"title":"Recart API","version":"2023-12"},"tags":[{"name":"OptinTool","description":"Opt-in tools"}],"servers":[{"url":"https://api.recart.com/app-integrations/2023-12","description":"Production"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Recart-API-Key","description":"It can be obtained in Recart account after contacting Support"}},"schemas":{"OptinTool":{"type":["object"],"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["optin-tools"]},"attributes":{"type":"object","required":["id","name","type","status","devices","channels"],"properties":{"id":{"type":"string","description":"ID of the opt-in tool"},"name":{"type":"string","description":"Name of the opt-in tool"},"type":{"type":"string","description":"Type of the opt-in tool","enum":["popup","landing-page","embedded-form","keyword"]},"status":{"type":"string","description":"Status of the opt-in tool","enum":["active","draft","inactive"]},"devices":{"type":"array","description":"Devices the tool targets","items":{"type":"string","enum":["mobile","desktop"]}},"channels":{"type":"array","description":"Channels the tool collects","items":{"type":"string","enum":["email","sms"]}},"statusSchedule":{"type":"object","description":"Upcoming scheduled status transitions. UTC Date and time in ISO 8601 format","properties":{"activateAt":{"type":"string","format":"date-time"},"inactivateAt":{"type":"string","format":"date-time"}}},"optinMethod":{"type":"object","description":"What handles a new opt-in","required":["type"],"properties":{"type":{"type":"string","description":"Type of the message handler","enum":["flow","integration"]},"flowId":{"type":"string","description":"ID of the flow the tool feeds (type flow only)"}}},"experimentIds":{"type":"array","description":"IDs of A/B experiments the tool participates in","items":{"type":"string"}},"steps":{"type":"array","description":"Steps of the tool (popup only)","items":{"type":"string","enum":["teaser","email","sms","smsWithEmail","oneTimePassword","oneClickVerification","oneClickOptin","success"]}},"messagingType":{"type":"string","description":"Messaging type of the tool (popup only)","enum":["two-way","one-way"]},"settings":{"type":"object","description":"Full tool settings (type-dependent). Returned only by getOptinTool;\nthe collection endpoint omits it.\n"}}}}},"HttpErrorBody":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["id","code","title","detail"],"properties":{"id":{"type":"string"},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}}}}}}},"responses":{"HttpError":{"description":"HTTP Error response","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/HttpErrorBody"}}}}}},"paths":{"/optin-tools/{id}":{"get":{"summary":"Receive a single opt-in tool","tags":["OptinTool"],"operationId":"getOptinTool","description":"Get opt-in tool by ID\n","parameters":[{"name":"id","in":"path","required":true,"description":"ID of the opt-in tool","schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OptinTool"}}}}}},"4XX":{"$ref":"#/components/responses/HttpError"},"5XX":{"$ref":"#/components/responses/HttpError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.recart.com/developers/public-api/optin-tool/receive-a-single-opt-in-tool.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.