{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/customers","auth":"required","examples":{"codes":[{"language":"html","code":"https://www.sendsonar.com/api/v1/customers?token=your_private_token&phone_number=3105551234","name":""}]},"method":"get","params":[{"name":"phone_number","type":"string","default":"+13105551234","desc":"The unique phone number of the customer you want to retrieve.","required":true,"in":"query","ref":"","_id":"554a8ec92fe1e61900ef5583"},{"name":"token","type":"string","default":"","desc":"Your private API token for your account.","required":true,"in":"query","ref":"","_id":"554a8ec92fe1e61900ef5582"},{"name":"email","type":"string","default":"","desc":"The email address of the customer you want to retrieve.","required":false,"in":"query","ref":"","_id":"5d7144718dce0b001269fe9a"},{"name":"customer_id","type":"string","default":"","desc":"The unique ID of the customer you want to retrieve.","required":false,"in":"query","ref":"","_id":"5d7144718dce0b001269fe99"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"phone_number\": \"+13105551234\",\n  \"email\": \"matt:::at:::sendsonar.com\",\n  \"first_name\": \"Matthew\",\n  \"last_name\": \"Berman\",\n  \"subscribed\": true,\n  \"unsubscribed_at\": null,\n  \"public_id\": \"4092e34b-a5bc-4b89-8268-7370ff47c3c2\",\n  \"external_id\": null,\n  \"properties\": {\n   \t\"cool_dude\": \"TRUE\"\n   },\n  \"assigned_phone_number\": \"+14155558888\",\n  \"assignee\": null,\n  \"doubly_opted_in\": false,\n  \"team_names\": []\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"GET Customer","type":"endpoint","slug":"get-customer","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"assigned_phone_number\",\n  \"body\": \"The assigned_phone_number part of the response is your company's phone number that this customer has sent or received a text message to/from.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Country Code\",\n  \"body\": \"Please always include a country code (such as +1 for US) in all API calls to us.\"\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5549651ccd09b317005f8f50","editedParams2":true,"parentDoc":null,"createdAt":"2015-05-06T00:49:32.326Z","githubsync":"","__v":7,"category":{"sync":{"isSync":false,"url":""},"pages":["55494ad0ee219b0d001743bb","55494b05f452670d00ec0c29","55494b11ee219b0d001743bf","55494b20ee219b0d001743c1","55494b2bee219b0d001743c3","55494b4a6a82a10d00817af5","55494b686a82a10d00817af9","5549651ccd09b317005f8f50","55497273cd09b317005f8f86","554977f0c634cf2d001250a7","55b970eab42b610d00c9b2e3","5696f3688560a60d00e2c216","5696f91c59a6692d003fad50","5696f92c24490c3700170a2d","5696f9700b09a41900b24422"],"title":"Public API","slug":"public-api","order":3,"from_sync":false,"reference":true,"_id":"55494a226a82a10d00817ae5","createdAt":"2015-05-05T22:54:26.925Z","project":"55208137623ff50d009b2bec","version":"55208137623ff50d009b2bef","__v":15},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55208138623ff50d009b2bf0","55494a226a82a10d00817ae5","55494ba7ee219b0d001743c8","55494bc1ee219b0d001743cc","56ead8c1df765617008bccaf","573a2073dd007d1700cf288f","579695b1f64c9f0e007cd76c","57969e3dfa1ff60e006a1274","579a4592fd9f3c0e008e4f4a","57ab9afe54fa780e006c5430","57b784f5b7ebd60e009cb4a6","58f686818193090f008cec76","59e79fbd4cf31900341d50c6","5b2436973fd93f0003dcf99d","5d824fb2ce98a801366098a2"],"_id":"55208137623ff50d009b2bef","createdAt":"2015-04-05T00:26:31.564Z","releaseDate":"2015-04-05T00:26:31.563Z","__v":15,"project":"55208137623ff50d009b2bec"},"project":"55208137623ff50d009b2bec","user":"55208129504fd6230022ae20","editedParams":true}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

phone_number:
required
string+13105551234
The unique phone number of the customer you want to retrieve.
token:
required
string
Your private API token for your account.
email:
string
The email address of the customer you want to retrieve.
customer_id:
string
The unique ID of the customer you want to retrieve.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "assigned_phone_number", "body": "The assigned_phone_number part of the response is your company's phone number that this customer has sent or received a text message to/from." } [/block] [block:callout] { "type": "info", "title": "Country Code", "body": "Please always include a country code (such as +1 for US) in all API calls to us." } [/block]