API Documentation

The Burner API allows access to three data collections:

All API endpoints require a bearer token. You need to obtain credentials on a user's behalf to use with Burner's OAuth 2.0 implementation. The access token you receive at the end of the authentication process should be passed in all API calls as Bearer token in the request header. Authorization: Bearer {your token}
Parameters are sent as a query string for GET and PUT and as a json body for POST

Burners

Request
/burners Returns a list of the user's active Burners. GET
Parameter Example Required Description
id bc208df9-d7a8-4b32-93ad-1cb213089f07 no Filter list by burner id
phoneNumber 16267771234 no Filter list by the Burner's phone number. You can optionally include a leading [+] but you must include the country code
name Craigslist no Filter list by the Burner's name
Response
[
  {
    "id":"bc208df9-d7a8-4b32-93ad-1cb213089f07",
    "name":"Craigslist",
    ...
    "expires":"2017-07-15T17:24:38+00:00"
  },
  {
    "id":"47e6c8de-04ae-4995-9cdb-4f6f16cd4700",
    "name":"Dating",
    ...
    "expires":"2017-08-15T17:24:38+00:00"
  }
]

Request
/burners/{burnerId} Updates a Burner's settings. PUT
Parameter Example Required Description
ringer true no A boolean value for if rings are on
notifications false no A boolean value for if notifications are on
autoReplyActive true no A boolean value for if auto-replies are on
autoReplyText true no The auto-reply text for the Burner
name Surfboarts no The name of the Burner
callerIdEnabled false no A boolean value that, if useSip is false, determines if incoming calls will have Burner (false) or the caller's (true) caller id
hexColor #ff0000 no A hex color for the burner
Response
[
  {
    "id":"bc208df9-d7a8-4b32-93ad-1cb213089f07",
    "name":"Craigslist",
    ...
    "expires":"2017-07-15T17:24:38+00:00"
  },
  {
    "id":"47e6c8de-04ae-4995-9cdb-4f6f16cd4700",
    "name":"Dating",
    ...
    "expires":"2017-08-15T17:24:38+00:00"
  }
]

Contacts

Request
/contacts Returns a list of the Burner's contacts. GET
Parameter Example Required Description
pageSize 10 no Number of results to return per page - default `10`
page 0 no Number of results to return per page - default `0`
blocked false no Returns only contacts with blocked equal to value provided
Response
[
  {
    "id": "1197fe31-e688-40da-b553-9431d084845c",
    "name": "Hack Nike",
    "phoneNumber": "+13234441111",
    "muted":true,
    "blocked":false,
    "burnerIds": [
      "717d1e13-f206-4b7e-9734-aca46131f581",
      "e65da9a1-0977-4aca-964e-2adeddba87ec"
    ]
  },
  {
    "id": "214f2fe0-9e4a-418c-8be1-26ef7c9048fc",
    "name": "Jennifer Government",
    "phoneNumber": "+13232221334",
    "muted":false,
    "blocked":false,
    "burnerIds": [
      "717d1e13-f206-4b7e-9734-aca46131f581"
    ]
  }
]

Request
/contacts/{contactPhoneNumber} Updates information about a given contact PUT
Parameter Example Required Description
name Bobby no A name for the contact
phoneNumber +17778889999 no The contact's phone number
muted true no If the contact should be muted
blocked false no If the contact should be blocked
Response
200 OK

Request
/contacts Creates a new contact POST
Parameter Example Required Description
name Bobby no A name for the contact
phoneNumber +17778889999 no The contact's phone number
burnerIds [{burnerId1}, {burnerId2}] no A list of burnerIds to associate the contact with
Response
200 OK

Messages

Request
/messages Creates and sends a new text message. POST
Parameter Example Required Description
burnerId {burnerId} yes The burnerId to send the message from
toNumber +18928919991 yes The phone number to send the message to
text Hey, this is Batman, what up? no The body of the text message
mediaUrl {url} no A media url you want to send (must be png,jpg,gif,mpg under 5 MB)
Response
200 OK