PhoneBurner API

https://www.phoneburner.com/developer/
Admin
PhoneBurner API is a RESTful web service that provides programmatic access to PhoneBurner's dialing...
Tokens:44,952
Snippets:195
Trust Score:9.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### cURL Example: Exchange Code for Access Token

Source: https://www.phoneburner.com/developer/authentication

Example using cURL to POST the authorization code and other required parameters to the /oauth/accesstoken endpoint to obtain an access token.

```shell
$ curl -X POST https://www.phoneburner.com/oauth/accesstoken \
               -d "client_id=878518e02c5e4bbf38784a0644db99feabe55a89" \
               -d "client_secret=6aff8f3bf1c273293c6536ed5e334609a5a0bf36" \
               -d "redirect_uri=http://www.mywebsite.com/callback_route.php" \
               -d "grant_type=authorization_code" \
               -d "code=nELDUs1Qscz2Z4P82sXMFreCQQCagVNSq5Tt0KlW"
```

--------------------------------

### GET /rest/1/content

Source: https://www.phoneburner.com/developer/route_list

Get available scripts and emails used throughout the system.

```APIDOC
## GET /rest/1/content

### Description
Get available scripts and emails used throughout the system.

### Method
GET

### Endpoint
/rest/1/content

### Parameters
#### Path Parameters
None

#### Query Parameters
- **type** (query, string) - Optional - Must be one of (onetouch, script, aac_email, add_appt_email, wmw_invitation, affiliate_invitation)
- **list** (query, string) - Optional - Must be one of (user, system, both)

### Request Example
```json
{
  "type": "onetouch",
  "list": "both"
}
```

### Response
#### Success Response (200)
- **cm_content_id** (string) - Content ID.
- **display_name** (string) - Display name of the content.
- **description** (string) - Description of the content.
- **message_id** (string) - Message ID.
- **display_order** (string) - Display order of the content.
- **system_message** (integer) - Indicates if the content is a system message (1) or user-generated (0).

#### Response Example
```json
{
    "http_status": 200,
    "status": "success",
    "content": {
        "emails": [
            {
                "cm_content_id": "1234",
                "display_name": "System message",
                "description": "This is an email shared from the master account",
                "message_id": "4046217",
                "display_order": "0",
                "system_message": 1
            },
            {
                "cm_content_id": "23295",
                "display_name": "User generated message",
                "description": "This message was created by the user",
                "message_id": "4046239",
                "display_order": "0",
                "system_message": 0
            }
        ]
    }
}
```
```

--------------------------------

### Handle Authorization Redirect

Source: https://www.phoneburner.com/developer/authentication

Example of the URL structure after the user approves the application and is redirected back to the callback URI.

```text
Example: https://www.yourdomain.com/callback_route2.php?code=878518e02c5e4bbf38784a06
```

--------------------------------

### OAuth Token Authentication Example

Source: https://www.phoneburner.com/developer/index

Use this header to authenticate requests with an OAuth token. Ensure the token is valid and has the necessary permissions.

```bash
$ curl -H 'Authorization: Bearer IJXYlIOkDEttK7cjk0lWyWHczRzWRCW1p60W5s1Z' https://www.phoneburner.com/rest/1/[route]
```

--------------------------------

### API Request with cURL

Source: https://www.phoneburner.com/developer/authentication

Example of using cURL to access a protected resource with an Authorization header.

```bash
$ curl https://www.phoneburner.com/rest/1/[route] -H 'Authorization: Bearer IJXYlIOkDEttK7cjk0lWyWHczRzWRCW1p60W5s1Z'
```

--------------------------------

### Initiate OAuth Authorization Flow

Source: https://www.phoneburner.com/developer/authentication

Construct the browser URL to start the OAuth authorization process for standard users or vendors.

```text
https://www.phoneburner.com/oauth/authorize?client_id=878518e02c5e4bbf38784a0644db99feabe55a89&redirect_uri=http%3A%2F%2Fwww.yourdomain.com%2Fcallback_route2.php&response_type=code
```

```text
https://www.phoneburner.com.com/oauth/authorize?client_id=878518e02c5e4bbf38784a0644db99feabe55a89&redirect_uri=http%3A%2F%2Fwww.yourdomain.com%2Fcallback_route2.php&response_type=code&owner_type=vendor
```

--------------------------------

### GET /oauth/authorize

Source: https://www.phoneburner.com/developer/authentication

Initiates the OAuth2 authorization flow to obtain an authorization code.

```APIDOC
## GET /oauth/authorize

### Description
Used to obtain an authorization code. If the user or vendor has not signed in, they will be redirected to /oauth/signin.

### Method
GET

### Endpoint
https://www.phoneburner.com/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The Client ID received from PhoneBurner.
- **redirect_uri** (string) - Required - The redirect_uri must match the client provided endpoint and be urlencoded.
- **response_type** (string) - Required - Must be 'code'.
- **state** (string) - Optional - Data to be sent back with the code.
- **owner_type** (string) - Optional - Set to 'vendor' if acting on behalf of a vendor account.

### Request Example
https://www.phoneburner.com/oauth/authorize?client_id=878518e02c5e4bbf38784a0644db99feabe55a89&redirect_uri=http%3A%2F%2Fwww.yourdomain.com%2Fcallback_route2.php&response_type=code
```

--------------------------------

### Update Member Account via API

Source: https://www.phoneburner.com/developer/route_list

Examples for updating member details using curl and PHP.

```bash
curl "https://www.phoneburner.com/rest/1/members/25381104" \
        -X PUT \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -d 'first_name=johnny5'
```

```php
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.phoneburner.com/rest/1/members/25381104" \
                 -X PUT \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
                 -d 'first_name=johnny5'";
$data = json_decode($results);
$member = $data->members->members[0];
print "Hello : {$member->username}\n";  //Hello : johnny5
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/phones/{phone_id}

Source: https://www.phoneburner.com/developer/route_list

Retrieves details for a specific phone number.

```bash
curl "https://www.phoneburner.com/rest/1/contacts/{contact_id}/phones/{phone_id}" \
    -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/phones

Source: https://www.phoneburner.com/developer/route_list

Retrieves a list of phone numbers for a contact.

```bash
curl "https://www.phoneburner.com/rest/1/phones" \
    -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

--------------------------------

### Retrieve Call Details via REST API

Source: https://www.phoneburner.com/developer/route_list

Example request and response for fetching specific call details using the call_id.

```bash
curl "https://www.phoneburner.com/rest/1/dialsession/call/1766999" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"

{
    "http_status": 200,
    "status": "success",
    "call":
    {
        "call":
        {
            "call_id": "1766999",
            "phone": "9495551234",
            "start_when": "2023-06-06 10:39:02",
            "end_when": "2023-06-06 10:39:18",
            "connected": "0",
            "voicemail": "1",
            "voicemail_sent": null,
            "email_sent": null,
            "email_ok": "0",
            "hangup_status": null,
            "message_id": null,
            "note": "-- Jun 06, 2023 8:39 am - PB - There was no answer.",
            "disposition": "No Answer"
        },
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/emails/{email_id}

Source: https://www.phoneburner.com/developer/route_list

Retrieves a specific email address for a contact.

```bash
curl "https://www.phoneburner.com/rest/1/contacts/{contact_id}/emails/{email_id}" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

--------------------------------

### GET /rest/1/content

Source: https://www.phoneburner.com/developer/route_list

Retrieve current content based on type and list filters.

```APIDOC
## GET /rest/1/content

### Description
Get current content.

### Method
GET

### Endpoint
/rest/1/content

### Parameters
#### Query Parameters
- **type** (string) - Optional - Must be one of (onetouch, script, aac_email, add_appt_email, wmw_invitation, affiliate_invitation)
- **list** (string) - Optional - Must be one of (user, system, both)

### Response
#### Success Response (200)
- **content** (object) - The requested content items

#### Response Example
{
    "http_status": 200,
    "status": "success",
    "content": {
        "emails": [
            {
                "cm_content_id": "1234",
                "display_name": "System message",
                "description": "This is an email shared from the master account",
                "message_id": "4046217",
                "display_order": "0",
                "system_message": 1
            }
        ]
    }
}
```

--------------------------------

### Get System Content with cURL

Source: https://www.phoneburner.com/developer/route_list

Retrieve system content such as one-touch scripts or emails by specifying the 'type' and 'list' parameters. The 'list' parameter can be 'user', 'system', or 'both'.

```bash
curl "https://www.phoneburner.com/rest/1/content?type=onetouch&list=both" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

```json
{
            "http_status": 200,
            "status": "success",
            "content": {
                "emails": [
                    {
                        "cm_content_id": "1234",
                        "display_name": "System message",
                        "description": "This is an email shared from the master account",
                        "message_id": "4046217",
                        "display_order": "0",
                        "system_message": 1
                    },
                    {
                        "cm_content_id": "23295",
                        "display_name": "User generated message",
                        "description": "This message was created by the user",
                        "message_id": "4046239",
                        "display_order": "0",
                        "system_message": 0
                    }
                ]
            }
        }
```

--------------------------------

### Contact Creation Request Payload

Source: https://www.phoneburner.com/developer/route_list

Example JSON structure for defining contact fields, tags, and configuration settings during creation.

```json
                    {"name":"Age Range","type":1,"value":"25-34"},
                    {"name":"Tried Product","type":2,"value":"yes"}
                ],
                "tags": [
                    "Tag Name 1",
                    "Tag Name 2",
                    "Tag Name 3"
                ],
                "phone":"9495551000",
                "phone_type":1,
                "phone_label":"Any label",
                "lead_id":3734,
                "category_id":"13186",
                "notes":"Add some notes to this contact.",
                "config": {
                    "import_dnc": 2
                }
            }'
```

--------------------------------

### Update Member Fields JSON Payload

Source: https://www.phoneburner.com/developer/route_list

Example JSON structure for updating member fields.

```json
    {
        "first_name": "foo",
        "last_name": "bar"
    }
```

--------------------------------

### Response shape for contact phones

Source: https://www.phoneburner.com/developer/route_list

Example JSON response structure returned when querying contact phone numbers.

```json
{
    "_link": {
        "self": {
            "href": "/rest/1/contacts/382390388/phones"
        }
    },
    "_links": {
        "self": {
            "href": "/rest/1/contacts/382390388/phones"
        }
    },
    "http_status": 200,
    "status": "success",
    "phones": {
        "phones": [
            {
                "id": 223987053,
                "type": 1,
                "phone_number": "716-293-9978",
                "label": "An updated title",
                "is_primary": true
            }
        ],
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### GET /rest/1/customfields - List Custom Fields

Source: https://www.phoneburner.com/developer/route_list

Retrieves a list of all custom fields. Supports pagination with `page_size` and `page` parameters. Requires an Authorization header.

```bash
curl "https://www.phoneburner.com/rest/1/customfields?page_size=1&page=1" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -d '{
    "http_status": 200,
    "status": "success",
    "customfields": {
        "customfields": [
            {
                "custom_field_id": "215",
                "display_name": "My custom field",
                "type_id": "1",
                "type_name": "Text Field",
                "display_order": "0",
                "_link": {
                    "self": {
                        "href": "rest/1/customfields/215"
                    }
                }
            }
        ],
        "page_size": 1,
        "total_results": "1",
        "page": 1,
        "total_pages": 1
    }
}'


```

--------------------------------

### Get User Account Tags with cURL

Source: https://www.phoneburner.com/developer/route_list

Fetch all tags associated with the user account for contacts. This endpoint returns a list of tags with their IDs and titles.

```bash
curl "https://www.phoneburner.com/rest/1/tags" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

```json
{
    "_link": {
        "self": {
            "href": "/rest/1/tags"
        }
    },
    "_links": {
        "self": {
            "href": "/rest/1/tags"
        }
    },
    "http_status": 200,
    "status": "success",
    "tags": {
        "tags": [
            {
                "id": 4406097,
                "title": "another tag"
            },
            {
                "id": 4406096,
                "title": "test"
            }
        ],
        "total_results": 2,
        "page": 1,
        "page_size": 2,
        "total_pages": 1
    }
}
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/phones

Source: https://www.phoneburner.com/developer/route_list

Get a list of phones associated with a contact.

```APIDOC
## GET /rest/1/contacts/{contact_id}/phones

### Description
Get a list of phones.

### Method
GET

### Endpoint
/rest/1/contacts/{contact_id}/phones

### Parameters
#### Path Parameters
- **contact_id** (string) - Required - The ID of the contact whose phones to retrieve.
```

--------------------------------

### POST /api_callbegin

Source: https://www.phoneburner.com/developer/route_list

Webhook callback triggered before every phone call to update your system.

```APIDOC
## POST /api_callbegin

### Description
This callback is used to update your system before every phone call. Your API should respond with an HTTP status of 200.

### Method
POST

### Request Body
- **lead_id** (string) - Required - The ID of the lead.
- **custom_data** (string) - Optional - Any data passed in initially.
- **ds_id** (string) - Required - The dial session ID.
- **call_id** (string) - Required - The specific call ID starting.

### Request Example
{
    "lead_id": "12345",
    "custom_data": "",
    "ds_id": "12345",
    "call_id": "12345"
}
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/emails/{email_id}

Source: https://www.phoneburner.com/developer/route_list

Get a specific email from a contact.

```APIDOC
## GET /rest/1/contacts/{contact_id}/emails/{email_id}

### Description
Get a specific email from a contact.

### Method
GET

### Endpoint
/rest/1/contacts/{contact_id}/emails/{email_id}

### Parameters
#### Path Parameters
- **contact_id** (string) - Required - The ID of the contact.
- **email_id** (string) - Required - The ID of the email address to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the email address.
- **email_address** (string) - The email address.
- **is_primary** (boolean) - Indicates if this is the primary email address.

#### Response Example
```json
{
    "_link": {
        "self": {
            "href": "/rest/1/contacts/382390387/emails/120954818"
        }
    },
    "_links": {
        "self": {
            "href": "/rest/1/contacts/382390387/emails/120954818"
        }
    },
    "http_status": 200,
    "status": "success",
    "email": {
        "id": 120954818,
        "email_address": "sallysample@getitonline.com",
        "is_primary": true
    }
}
```
```

--------------------------------

### GET /rest/1/folders

Source: https://www.phoneburner.com/developer/route_list

Get a list of contact manager folders. Optionally retrieve folders with embedded data to show the folder structure.

```APIDOC
## GET /rest/1/folders

### Description
Get a list of contact manager folders.

### Method
GET

### Endpoint
/rest/1/folders

### Parameters
#### Query Parameters
- **structure** (string) - Optional - If set to '1', we will return the folders with _embedded data to show the folder structure.

### Request Example (Basic)
```bash
curl "https://www.phoneburner.com/rest/1/folders" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

### Response Example (Basic)
```json
{
    "http_status": 200,
    "status": "success",
    "folders":
    {
        "0":
        {
            "folder_id": "11888",
            "folder_name": "Folder #1"
        },
        "1":
        {
            "folder_id": "11999",
            "folder_name": "Folder #2"
        },
        "2":
        {
            "folder_id": "11000",
            "folder_name": "Folder #3"
        }
    }
}
```

### Request Example (With Structure)
```bash
curl "https://www.phoneburner.com/rest/1/folders?structure=1" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

### Response Example (With Structure)
```json
{
    "http_status": 200,
    "status": "success",
    "folders":
    {
        "0":
        {
            "id": "11888",
            "folder_id": "11888",
            "folder_name": "Folder #1",
            "description": "A Description",
            "_links": {
                "self": {
                    "href": "rest/1/folders/118888"
                }
            }
        },
        "1":
        {
            "id": "11990",
            "folder_id": "11990",
            "folder_name": "Folder #2",
            "description": "A Description",
            "_links": {
                "self": {
                    "href": "rest/1/folders/11990"
                }
            },
            "_embedded": {
                "folders": [
                    {
                        "id": "11991",
                        "folder_id": "11991",
                        "folder_name": "Sub Folder #2 - 1",
                        "description": "A Description",
                        "_links": {
                            "self": {
                                "href": "rest/1/folders/11991"
                            }
                        }
                    },
                    {
                        "id": "11992",
                        "folder_id": "11992",
                        "folder_name": "Sub Folder #2 - 2",
                        "description": "A Description",
                        "_links": {
                            "self": {
                                "href": "rest/1/folders/11992"
                            }
                        }
                    }
                ]
            }
        }
    }
}
```
```

--------------------------------

### Create New Member with cURL

Source: https://www.phoneburner.com/developer/route_list

Use this cURL command to create a new member account. Vendor level access is required. Ensure all required form parameters are included.

```bash
curl "https://www.phoneburner.com/rest/1/members/" \
        -X POST \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -d 'username=gumby&password=abcdef&first_name=foobar&email=gumby%40networxonline.com&billing_item_id=183&billing_group_id=63&subgroup_id=1243'
```

```json
{
        "http_status": 201,
        "status": "success",
        "members": {
            "members": {
                "user_id": "25381104",
                "username": "gumby",
                "first_name": "foobar",
                "last_name": "",
                "email_address": "gumby@networxonline.com",
                "date_added": "2023-09-22 14:51:38",
                "phone": null,
                "display_name": "7.5 Hour Account",
                "billing_item_id": "183",
                "subscription_status": "1",
                "oauth": {
                    "bearer_token": "examplenEnTQoSx8sWmLBtbrhcgp8sReWxIvITGN"
                }
            },
            "total_results": 1,
            "page": 1,
            "page_size": 1,
            "total_pages": 1
        }
}
```

--------------------------------

### GET /rest/1/customfields/{custom_field_id} - Get Specific Custom Field

Source: https://www.phoneburner.com/developer/route_list

Retrieves details for a specific custom field using its ID. Requires an Authorization header.

```bash
curl "https://www.phoneburner.com/rest/1/customfields/{custom_field_id}" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -d '{
    "http_status": 200,
    "status": "success",
    "customfields": {
        "customfields": [
            {
                "custom_field_id": "215",
                "display_name": "My custom field",
                "type_id": "1",
                "type_name": "Text Field",
                "display_order": "0",
                "_link": {
                    "self": {
                        "href": "rest/1/customfields/215"
                    }
                }
            }
        ]
    }
}'


```

--------------------------------

### Hello World - Test API Connectivity

Source: https://www.phoneburner.com/developer/examples

Use this simple, unprotected route to verify network connectivity to the PhoneBurner API. No authentication is required.

```bash
$ curl https://www.phoneburner.com/rest/1/tranquility

{
    "http_status": 200,
    "status": "success",
    "tranquility": 
    {
        "tranquility": 
        [
            
            {
                "meaning": "the quality or state of being tranquil; calm."
            }
        ],
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### Create Folder using cURL

Source: https://www.phoneburner.com/developer/route_list

Use this endpoint to create a new folder. Provide the folder name, an optional description, and a parent_id if creating a subfolder. The response includes the new folder's ID and name.

```bash
curl -X POST "https://www.phoneburner.com/rest/1/folders" \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \

        -d '{
    "name": "Folder #1",
    "description": "My Description",
    "parent_id": 132022
}'
```

```json
{
    "http_status": 200,
    "status": "success",
    "folders":
    {
        "0":
        {
            "folder_id": "11888",
            "folder_name": "Folder #1"
        }
    }
}
```

--------------------------------

### GET /rest/1/voicemails

Source: https://www.phoneburner.com/developer/route_list

Retrieves currently available voicemail data.

```APIDOC
## GET /rest/1/voicemails

### Description
Get currently available voicemail data. These voicemails can be left for your contacts during a dial session with the click of a button.

### Method
GET

### Endpoint
/rest/1/voicemails

### Response
#### Success Response (200)
- **http_status** (integer) - HTTP status code
- **status** (string) - Operation status
- **voicemails** (object) - Container for voicemail list and pagination metadata

#### Response Example
{
    "http_status": 200,
    "status": "success",
    "voicemails": {
        "voicemails": [
            {
                "recording_id": "170999",
                "name": "Basic Voicemail",
                "playback_url": "http://sampledomain.com/pbx/dsrecording/AH-AEE-AAADGFF/170999/x.mp3",
                "created_when": "2013-11-07 10:16:56"
            }
        ],
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### GET /rest/1/tags

Source: https://www.phoneburner.com/developer/route_list

Retrieve tags by user account for all contacts.

```APIDOC
## GET /rest/1/tags

### Description
Tags by user account for all contacts.

### Method
GET

### Endpoint
/rest/1/tags

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the tag.
- **title** (string) - The name of the tag.

#### Response Example
```json
{
    "_link": {
        "self": {
            "href": "/rest/1/tags"
        }
    },
    "_links": {
        "self": {
            "href": "/rest/1/tags"
        }
    },
    "http_status": 200,
    "status": "success",
    "tags": {
        "tags": [
            {
                "id": 4406097,
                "title": "another tag"
            },
            {
                "id": 4406096,
                "title": "test"
            }
        ],
        "total_results": 2,
        "page": 1,
        "page_size": 2,
        "total_pages": 1
    }
}
```
```

--------------------------------

### GET /rest/1/dialsession/call/{call_id}

Source: https://www.phoneburner.com/developer/route_list

Retrieves detailed information about a specific call.

```APIDOC
## GET /rest/1/dialsession/call/{call_id}

### Description
Returns call detail for a specific call ID.

### Method
GET

### Endpoint
/rest/1/dialsession/call/{call_id}

### Parameters
#### Path Parameters
- **call_id** (integer) - Required - The call ID.

#### Query Parameters
- **include_recording** (integer) - Optional - If set to 1, includes a URL to the recordings.

### Response
#### Success Response (200)
- **call** (object) - The call details object.

### Response Example
{
    "http_status": 200,
    "status": "success",
    "call": {
        "call_id": "1766999",
        "phone": "9495551234",
        "start_when": "2023-06-06 10:39:02",
        "end_when": "2023-06-06 10:39:18",
        "connected": "0",
        "disposition": "No Answer"
    }
}
```

--------------------------------

### Create a new tag

Source: https://www.phoneburner.com/developer/route_list

Adds a new tag to the system using a POST request.

```bash
curl "https://www.phoneburner.com/rest/1/tags" \
    -X POST \
    -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
    -d '{"title": "Your tag title goes here"}'
```

--------------------------------

### Create New Member with PHP

Source: https://www.phoneburner.com/developer/route_list

This PHP script uses cURL to create a new member account and then decodes the JSON response to display the username. Vendor level access is required.

```php
<?php
$results = `curl -s -k "https://www.phoneburner.com/rest/1/members/" \
                 -X POST \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
                 -d 'username=gumby&password=abcdef&first_name=foobar&email=gumby%40networxonline.com&billing_item_id=183&billing_group_id=63&subgroup_id=1243'`;
$data = json_decode($results);
$member = $data->members->members[0];
print "Hello : {$member->username}\n"; //Hello : foobar

```

--------------------------------

### GET /rest/1/customfields/{custom_field_id}

Source: https://www.phoneburner.com/developer/route_list

Retrieves a specific custom field by its ID.

```APIDOC
## GET /rest/1/customfields/{custom_field_id}

### Description
Get a specific custom field by its ID.

### Method
GET

### Endpoint
/rest/1/customfields/{custom_field_id}

### Path Parameters
- **custom_field_id** (string) - Required - The ID of the custom field to retrieve.

### Response
#### Success Response (200)
- **customfields** (object) - Contains the details of the requested custom field.
  - **customfields** (array) - An array containing a single custom field object.
    - **custom_field_id** (string) - The unique identifier for the custom field.
    - **display_name** (string) - The name of the custom field as displayed in the UI.
    - **type_id** (string) - The ID of the custom field type.
    - **type_name** (string) - The name of the custom field type.
    - **display_order** (string) - The order in which the custom field is displayed.
    - **_link** (object) - Links related to the custom field.

### Request Example
```json
{
    "http_status": 200,
    "status": "success",
    "customfields": {
        "customfields": [
            {
                "custom_field_id": "215",
                "display_name": "My custom field",
                "type_id": "1",
                "type_name": "Text Field",
                "display_order": "0",
                "_link": {
                    "self": {
                        "href": "rest/1/customfields/215"
                    }
                }
            }
        ]
    }
}
```
```

--------------------------------

### POST /rest/1/folders

Source: https://www.phoneburner.com/developer/route_list

Create a new folder in your PhoneBurner account.

```APIDOC
## POST /rest/1/folders

### Description
Create a new folder.

### Method
POST

### Endpoint
/rest/1/folders

### Parameters
#### Request Body
- **name** (string) - Required - Name of the new folder
- **description** (string) - Optional - Description of this folder.
- **parent_id** (int) - Optional - Parent ID. This allows to create sub folders. Currently limited to 1 layer of subfolders.

### Request Example
```json
{
    "name": "Folder #1",
    "description": "My Description",
    "parent_id": 132022
}
```

### Response
#### Success Response (200)
- **folder_id** (string) - The ID of the newly created folder.
- **folder_name** (string) - The name of the newly created folder.

#### Response Example
```json
{
    "http_status": 200,
    "status": "success",
    "folders": {
        "0": {
            "folder_id": "11888",
            "folder_name": "Folder #1"
        }
    }
}
```
```

--------------------------------

### Get Contact Tags

Source: https://www.phoneburner.com/developer/route_list

Retrieves a list of tags associated with a specific contact.

```curl
curl "https://www.phoneburner.com/rest/1/contacts/{contact_id}/tags" \
    -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

```json
{
    "_link": {
        "self": {
            "href": "/rest/1/contacts/382390387/tags"
        }
    },
    "_links": {
        "self": {
            "href": "/rest/1/contacts/382390387/tags"
        }
    },
    "http_status": 200,
    "status": "success",
    "tags": {
        "tags": [
            {
                "id": 4406098,
                "title": "SampleTag"
            }
        ],
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### GET /rest/1/contacts/{contact_id}

Source: https://www.phoneburner.com/developer/route_list

Retrieves the details of a specific contact using its ID.

```APIDOC
## GET /rest/1/contacts/{contact_id}

### Description
Retrieves a specific contact.

### Method
GET

### Endpoint
/rest/1/contacts/{contact_id}

### Parameters
#### Path Parameters
- **contact_id** (String) - Required - The ID of the contact to retrieve.

#### Query Parameters
- **sort_order** (string) - Optional - Default is 'DESC'. 'ASC' for oldest first.
- **page_size** (string) - Optional - Number of results to fetch. Default is 25. 1...100 is valid.
- **page** (string) - Optional - Page number to fetch. Default is 1.
```

--------------------------------

### Access Authenticated Route with OAuth Token

Source: https://www.phoneburner.com/developer/examples

To access protected resources, include an `Authorization` header with your OAuth access token. Substitute your actual access token for the placeholder.

```bash
$ curl https://www.phoneburner.com/rest/1/members/ \
-H "Authorization: Bearer EibGl9i8WNi0iI3a0He6PYg1Kntpzq8y3foSxQyg"

{
        "http_status": 200,
        "status": "success",
        "members":
        {
                "total_results": 1,
                "members":
                [

                        {
                                "user_id": "1234567",
                                "username": "saulgoodman",
                                "first_name": "Saul",
                                "last_name": "Goodman",
                                "email_address": "callsaul@bettercallsaul.com",
                                "date_added": "2013-01-17 17:12:13",
                                "phone": "9492181234",
                                "display_name": "Standard Account",
                                "billing_item_id": "131",
                                "subscription_status": "1",
                                "_link":
                                {
                                        "self":
                                        {
                                                "href": "\/rest\/1\/members\/1234567"
                                        }
                                }
                        }
                ],
                "page": 1,
                "page_size": 1,
                "total_pages": 1
        }

}
```

--------------------------------

### GET /rest/1/customfields

Source: https://www.phoneburner.com/developer/route_list

Retrieves a list of all custom fields associated with the account. Supports pagination.

```APIDOC
## GET /rest/1/customfields

### Description
Get a list of custom fields.

### Method
GET

### Endpoint
/rest/1/customfields

### Query Parameters
- **page_size** (integer) - Optional - The number of results to return per page.
- **page** (integer) - Optional - The page number of the results to retrieve.

### Response
#### Success Response (200)
- **customfields** (object) - Contains the list of custom fields and pagination details.
  - **customfields** (array) - An array of custom field objects.
    - **custom_field_id** (string) - The unique identifier for the custom field.
    - **display_name** (string) - The name of the custom field as displayed in the UI.
    - **type_id** (string) - The ID of the custom field type.
    - **type_name** (string) - The name of the custom field type.
    - **display_order** (string) - The order in which the custom field is displayed.
    - **_link** (object) - Links related to the custom field.
  - **page_size** (integer) - The number of results per page.
  - **total_results** (integer) - The total number of custom fields available.
  - **page** (integer) - The current page number.
  - **total_pages** (integer) - The total number of pages available.

### Request Example
```json
{
    "http_status": 200,
    "status": "success",
    "customfields": {
        "customfields": [
            {
                "custom_field_id": "215",
                "display_name": "My custom field",
                "type_id": "1",
                "type_name": "Text Field",
                "display_order": "0",
                "_link": {
                    "self": {
                        "href": "rest/1/customfields/215"
                    }
                }
            }
        ],
        "page_size": 1,
        "total_results": "1",
        "page": 1,
        "total_pages": 1
    }
}
```
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/tags

Source: https://www.phoneburner.com/developer/route_list

Retrieve a list of tags associated with a specific contact.

```APIDOC
## GET /rest/1/contacts/{contact_id}/tags

### Description
Get a list of tags.

### Method
GET

### Endpoint
/rest/1/contacts/{contact_id}/tags

### Parameters
#### Path Parameters
- **contact_id** (string) - Required - The ID of the contact

### Response
#### Success Response (200)
- **tags** (object) - List of tags and pagination metadata

#### Response Example
{
    "http_status": 200,
    "status": "success",
    "tags": {
        "tags": [
            {
                "id": 4406098,
                "title": "SampleTag"
            }
        ],
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
    }
}
```

--------------------------------

### Accessing Protected Resources

Source: https://www.phoneburner.com/developer/authentication

How to access protected resources using an access token.

```APIDOC
## Accessing Protected Resources

### Description
Accessing resources with the OAuth token follows a basic flow where the client sends an API request with the access token in the Authorization header to the Resource Server.

### Method
Any (e.g., GET, POST, PUT, DELETE)

### Endpoint
https://www.phoneburner.com/rest/1/[route]

### Parameters
#### Request Headers
- **Authorization** (string) - Required - The access token in the format `Bearer [YOUR-OAUTH-ACCESS-TOKEN]`.

### Request Example
```bash
curl https://www.phoneburner.com/rest/1/[route] -H 'Authorization: Bearer IJXYlIOkDEttK7cjk0lWyWHczRzWRCW1p60W5s1Z'
```

### Response
#### Success Response (200)
- The response will contain the requested protected resource.

#### Error Response
- If the token is invalid or expired, an appropriate error message will be returned.
```

--------------------------------

### Accessing Protected Resources

Source: https://www.phoneburner.com/developer/authentication

Demonstrates how to use the obtained access token to make authenticated requests to the PhoneBurner API.

```APIDOC
### Accessing the API with an Access Token

The access token allows you to make requests to the API on behalf of a user.

```bash
curl -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' https://www.phoneburner.com/[api_route]
```
```

--------------------------------

### Get Specific Contact Tag

Source: https://www.phoneburner.com/developer/route_list

Retrieves details for a specific tag assigned to a contact.

```curl
curl "https://www.phoneburner.com/rest/1/contacts/{contact_id}/tags/{tag_id}" \
    -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"
```

```json
{
    "_links": {
        "self": {
            "href": "/rest/1/contact/382390387/tags/4406099"
        }
    },
    "http_status": 202,
    "status": "success",
    "tag": {
        "id": 4406099,
        "title": "Sample Tag"
    }
}
```

--------------------------------

### Access Protected Resource Without Credentials

Source: https://www.phoneburner.com/developer/examples

Attempting to access a protected resource without providing authentication credentials will result in a 401 error.

```bash
$ curl https://www.phoneburner.com/rest/1/members/3288104

{
    "http_status": 401,
    "status": "error",
    "debug_codes": 
    [
        
        {
            "code": 40101,
            "reason": "Login Failure: Authorization Header required"
        }
    ]
}
```

--------------------------------

### GET /rest/1/contacts/{contact_id}/auditlog

Source: https://www.phoneburner.com/developer/route_list

Retrieves the audit log of changes made to a specific contact.

```APIDOC
## GET /rest/1/contacts/{contact_id}/auditlog

### Description
Retrieves the audit log for a contact, showing changes made over time.

### Method
GET

### Endpoint
/rest/1/contacts/{contact_id}/auditlog

### Parameters
#### Path Parameters
- **contact_id** (integer) - Required - The ID of the contact.

### Request Example
```json
{
    "http_status": 200,
    "status": "success",
    "contact_activities": {
        "contact_activities": [
            {
                "contact_id": "106558881",
                "member_id": "106556250",
                "action": "update",
                "data_type": "moved",
                "old": "131941",
                "new": "13186",
                "date_added": "2016-02-22 18:24:34"
            }
        ],
        "page_size": 1,
        "total_results": "68",
        "page": 1,
        "total_pages": 68
    }
}
```

### Response
#### Success Response (200)
- **http_status** (integer) - The HTTP status code.
- **status** (string) - The status of the response ('success' or 'error').
- **contact_activities** (object) - Contains the audit log entries.
  - **contact_activities** (array) - An array of audit log objects.
    - **contact_id** (string) - The ID of the contact.
    - **member_id** (string) - The ID of the member who made the change.
    - **action** (string) - The type of action performed (e.g., 'update').
    - **data_type** (string) - The type of data that was changed (e.g., 'moved').
    - **old** (string) - The previous value of the data.
    - **new** (string) - The new value of the data.
    - **date_added** (string) - The date and time the change was added.
  - **page_size** (integer) - The number of results per page.
  - **total_results** (string) - The total number of results.
  - **page** (integer) - The current page number.
  - **total_pages** (integer) - The total number of pages.
```
Tokens:
Raw