-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7ad0e5b
commit 57d4cbe
Showing
5 changed files
with
239 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| id: get-subscriber | ||
| title: "Get a subscriber" | ||
| description: "Get a subscriber by email" | ||
| sidebar_label: "Get a subscriber" | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: eJy9WG1zGzUQ/iua4wt4bCdxE0r9iVDSEijQadJhmCaDdXdyTnAnHZIuiXH933lW0p3PsXEDBfzF9u1K+6Jnn13dMnH8xibTd4ltUpsZmQpjk+thkgv6VzupVTJNXgrHOFursHTBRMVlmQwTXQvDSe88h+aNcBedGqRG2ForK2BjmUwOD+lrc++1OpvrRuVjrMq0ckI5UuZ1XcrMGzj41dKKZWKzAtbpl1vUAnvo9FeROSysDbnjZLCXc/cILZn3dKwzUt14x3n+oyoXydSZRqyGSYh3n/teg/E8R9AWWzzccq5NxRFU0qZO3POqLkkn/vrSS8aZrhJYrAutxF6LXoOppsKfMTt3yGBZ6jvLXCHY2fjo82MWjI73uRPs9Nw5OTk6etZ+KBW/N9IIpGnOS0u5ULza75hX2Da5DvhbXSj2tRbJru2t466xew1ElR0mkA3C89wI8YvtQ7HmMt980qju74bkuu/p9kbbDmeNdbp6IUWZ73D7uZeyeRBvre9i4MbwBeTSicr+a7gteSrKXZrrEPmNILzd8rIRezUnJ6sVFJ10ft3zfth0buKmQtn6Yn0lrdt1hD0VVnqd3v44tvmTp+kh/2KUi6Nno+P508mIPxX56DDNj7L06ZP55NmcsPsYteu/n+oYci/Gi62YIExLnv1G3ov81O3FaU+TgY52FUVXhyQfOVmJXcfYx+oHbPZVP85ohicfjtFr0Xl+XIB1/ghbQetjLPXPdl3Vq4AVYd35jrJa+c8wOT483k972v3rTaxCM6EC3VvBu33YH9QGyT2mntosnOxq4+cI1iheMivMLTVDY7T5v9PwF078J3mgBs0N+pyjkWn6bhm7YnI/4rUc/SY8v1BqCgDQN47NjP2sG8NOX5+zoLqmKoLpcDsxHRaHnal2kPBmau6KLSN7xpPHGwSRIsxCxwHP91LYmiYH6754sPT7rxJqA5T8kJPGlJQB52o7PTgAFhQOd1xj3xTESJPOwe1RQhakmuttWL1VSB2avcrZjVCYNEuGTTJROztk7XCJR1g1ZKTFG8w+ykWYYU7AcCpuAKLxlbpSn3zCvuJY8PbNqyt1iSHpdfTEH4S0LG1k6RgWDgZvzi4uBwNWIwmZBDzsmP0kmICbJhOQf3N5+foCClIxgXgXLGKMOc1kBfTeep7C3Cyyxki3GEIVvoSf5Cu2vuXZYszIE3Ig18L6ArZNXWvjopXBwDt/WpatDUtZcBymadILUx8iYWkMbkr6s9nsSn0g9VHrSo1Go5ig040M0sOtRDUY6FvoWoq3l3XR+ThmgDjLuOoyQ0FXXKGO2aKHfsvupCsYPXk3GLSxO8GrweD60zaCQpR1JqjCN4P4zCfn8oET2J8pgQZI3uXAhfKBaSP/CMgIVRksUxIjT1mm5/5/lKeC8jrrinqKMxnM2F0hjGAz/xuw6aL5TizGXe43F3Wp7hc+LW6URHrIUb8NzzLQd0iWLXRT5nACurULSBJjDM4BJQU3m5kkMNZNCpYtF7QRKl2mpWDQ4xaoygqG75fSfdOkQ5aVEhGPrMxDCQVUWg38+yAAd0xNGpjPzALmH1qiv4RwjzpHehbuIXvcMekotODwEIDxWTw9uxhNTj6ftTvKaGgNvjdtST+nkqaHHfA86DwVcJMzqotQ977eVB6OnU4OYVLgTONGCUoil3Cm3vkOmrTzuWo5Zchmk/v7WX/TTJtALx5BcUvoHZNeUKHkgwzIMTMyoqTxpbUY2Wh2sq0OojMcvNRkjlyT1jaRnd77qBlj79nXaxZk70ky8h/W/oj/SDLDtXpGa378jnWfVnLkJc/DHNeTHB8+8ZIX2qQyz4XqSY695AcA7AXNET3Js7CbVnMgzPV2m0y85K0C7VGiOIHuDLXoFp1KWHypNfueqwVOOjJZkJ/EILoWfhFa+Bm1cNLZQAkd9StZSQdwbIAk0rNlRPu4YEDF9qCJ06HzIgKKZQ444+bs4cHEfeYZA4/Xy4dedCc9+WZCgtV5DCdcQv3xjluerPi9rJoqXsrJSkfZvi4ILNaTohXILWpkMDhZ69R0txXgojySPu2ZNmiBwSWvP+n00X44vZqhUbelwdqgHYE/XCGBwjviY9BkRdbQ7ZuMKrELEavvCglaoCC7Btbm5RJbeF9BQDm9akip7p3RcRvOsADUVYms4Eraimpuw8g6DdS2G9QUPNsRbXcGBUeCbS0yOZcZizMK3cAQi+95wN0/bhJrBF2E9Z4GeoYJmN431J0nEN9CaNMhwwjAreic+KhudcaR8t68EDPewgzEoAhl3dSKJqM8TZNiqvNFl6+2x7VuRX86d2kOCQtxlP0NsYZ8BCAZ5CjV+WKDI+EnZjka5MIkdjQ+HB8m68vTecSBH9RoGNbWobfTCBen04dvDR8Op8v13WDvG8Y4jjpx7w7qEkMPmfOD5TIOov3Xl1gwDSsxVBZwisTLJfWot6ZcregxAjS4D767ppceRhJb+Wk1l5651q8L/tLfT9/E6fkz9uE3gJuet68gFE398Z1Lgp90DWhH+tU1FOO94R879uCCsdOZYLR/Zek8ontGEJ9mNHD3ZFsXuY0rwsuzS1wa/gQ2DLtz | ||
| sidebar_class_name: "get api-method" | ||
| info_path: docs/api/introduction | ||
| custom_edit_url: null | ||
| --- | ||
|
|
||
| import ApiTabs from "@theme/ApiTabs"; | ||
| import DiscriminatorTabs from "@theme/DiscriminatorTabs"; | ||
| import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
| import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; | ||
| import MimeTabs from "@theme/MimeTabs"; | ||
| import ParamsItem from "@theme/ParamsItem"; | ||
| import ResponseSamples from "@theme/ResponseSamples"; | ||
| import SchemaItem from "@theme/SchemaItem"; | ||
| import SchemaTabs from "@theme/SchemaTabs"; | ||
| import Markdown from "@theme/Markdown"; | ||
| import OperationTabs from "@theme/OperationTabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| <h1 className={"openapi__heading"}>Get a subscriber</h1> | ||
|
|
||
| <MethodEndpoint method={"get"} path={"/subscriber/{email}"}></MethodEndpoint> | ||
|
|
||
|
|
||
|
|
||
| Get a subscriber by email | ||
|
|
||
| ## Request | ||
|
|
||
| <details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"email","in":"path","description":"Subscriber email address","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"x-api-key","in":"header","description":"Your API key","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div> | ||
|
|
||
| Subscriber found. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"description":"Subscriber email address","type":"string","format":"email","example":"example@email.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"phone"} qualifierMessage={undefined} schema={{"description":"Subscriber phone number. It follows the E.164 format.","type":"string","format":"phone","example":5511999999999,"required":false}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Subscriber name","type":"string","example":"John Doe","required":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`free_subscriber`, `paid_subscriber`, `unsubscribed_subscriber`]"} schema={{"description":"Subscriber status","type":"string","enum":["free_subscriber","paid_subscriber","unsubscribed_subscriber"],"example":"free_subscriber","required":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>customFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}> | ||
|
|
||
| Custom fields | ||
|
|
||
| </div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"age"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":25}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segmentationLists"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Segmentation lists","example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"],"required":false,"type":"array","items":{"type":"string"},"title":"SegmentationLists"}}></SchemaItem><SchemaItem collapsible={false} name={"blacklistedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber blacklisted date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"unsubscribedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber unsubscribed date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber creation date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber update date","type":"string","format":"date-time","readOnly":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"data\": {\n \"id\": \"string\",\n \"email\": \"example@email.com\",\n \"phone\": 5511999999999,\n \"name\": \"John Doe\",\n \"status\": \"free_subscriber\",\n \"customFields\": [\n {\n \"id\": \"string\",\n \"label\": \"age\",\n \"value\": 25\n }\n ],\n \"segmentationLists\": [\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\",\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\"\n ],\n \"blacklistedAt\": \"2024-03-30T17:37:47.843Z\",\n \"unsubscribedAt\": \"2024-03-30T17:37:47.843Z\",\n \"createdAt\": \"2024-03-30T17:37:47.843Z\",\n \"updatedAt\": \"2024-03-30T17:37:47.843Z\"\n },\n \"requestId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div> | ||
|
|
||
| Subscriber not found. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Subscriber not found."}}></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \"Subscriber not found.\",\n \"requestId\": \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div> | ||
|
|
||
| Internal server error. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Internal server error."}}></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \"Internal server error.\",\n \"requestId\": \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> | ||
|
|
Oops, something went wrong.