API Retrieve Status Lists - Shape Software - Automate your business!

Instructions

Shape Software API

  • Introduction
  • Using Shape APIs
  • Status Codes
  • Rate Limits

POST API Calls

GET API Calls

Retrieve Status Lists

GET /get/statuses

To retrieve status lists from Shape, send an authorized GET request to https://secure.setshape.com/api/get/statuses

Request Header

The authentication token should be passed in the request header for every API request. 

Content-Type: application/json
Authorization=xxxxxxxxxxxxxxxxxxxxxxxx

Response

Upon success, the server returns HTTP codes and messages in the header with some additional elements and properties that are set by the server, such as id.

{
    "message": "Statues retrieved successfully",
    "statues": [
        {
            "id": 1,
            "title": "Sales Status",
            "status": [
                {
                    "id": 1,
                    "title": "New Prospect"
                },
                {
                    "id": 4,
                    "title": "Contacted - Follow Up"
                },
                {
                    "id": 7,
                    "title": "No Contact - Left Message"
                },
                {
                    "id": 10,
                    "title": "Bad Number - Email Sent"
                },
                {
                    "id": 16,
                    "title": "Active Working Deal"
                },
                {
                    "id": 40,
                    "title": "Contract Out"
                },
                {
                    "id": 43,
                    "title": "Deal Closed"
                },
                {
                    "id": 55,
                    "title": "Contact in Future"
                },
                {
                    "id": 67,
                    "title": "Do Not Contact"
                },
                {
                    "id": 70,
                    "title": "Not Interested"
                },
                {
                    "id": 73,
                    "title": "Return Lead - Credit"
                },
                {
                    "id": 277,
                    "title": "Bad Contact Info"
                },
            ]
        },
}

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.