API Retrieve Users - Shape Software - Automate your business!

Instructions

Shape Software API

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

POST API Calls

GET API Calls

Retrieve Users

GET /get/statuses

To get all users of the crm/company from Shape, send an authorized GET request to https://secure.setshape.com/api/users

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": "Users fetched successfully.",
    "users": [
        {
            "id": 4,
            "firstname": "John",
            "lastname": "Doe",
            "email": "johndoe@setshape.com",
            "phone": "5555555555"
        },
        {
            "id": 10,
            "firstname": "Jane",
            "lastname": "Doe",
            "email": "janedoe@setshape.com",
            "phone": "4444444444"
        },
        {
            "id": 13,
            "firstname": "Mike",
            "lastname": "Smith",
            "email": "mikesmith@setshape.com",
            "phone": "3333333333"
        },
          ]
}

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.