Skip to main content
POST
/
index.php
/
api
/
dakota
cURL
curl --request POST \
  --url https://marketplace-as-a-service.herokuapp.com/index.php/api/dakota \
  --header 'Content-Type: text/plain' \
  --header 'Oauth-Token: <api-key>' \
  --data '<JSON example>'

How to Use

  1. Copy any of the JSON examples below.
  2. Go to the API playground by clicking on the “Try it” button.
  3. Paste the JSON into the request body field.
  4. Click “Send” button to execute the request.

Examples

Count Contact Records

{
  "module": "contact",
  "count_only": "1"
}

List All Contacts

{
  "module": "contact"
}

List Contacts with Specific Fields

{
  "module": "contact",
  "filters": {
    "fields": ["firstname", "createddate", "contact_type__c", "metro_area__c"],
    "order_by": "firstname:DESC",
    "max_num": "10"
  }
}

Filter By Contact ID

{
  "module": "contact",
  "filters": {
    "filter": [
      {
        "sfid": {
          "$equals": "0017600000cmqHcAAI"
        }
      }
    ]
  }
}

Filter By Contact Type (Administrator)

{
  "module": "contact",
  "filters": {
    "filter": [
      {
        "contact_type__c": {
          "$equals": "Administrator"
        }
      }
    ]
  }
}

Filter By Contact Type (Not Assistant)

{
  "module": "contact",
  "filters": {
    "filter": [
      {
        "contact_type__c": {
          "$not_equals": "Assistant"
        }
      }
    ]
  }
}

Filter By Contact Name (OR Example)

{
  "module": "contact",
  "filters": {
    "filter": [
      {
        "$or": [
          {
            "firstname": {
              "$contains": "Test"
            }
          },
          {
            "firstname": {
              "$equals": "Test2"
            }
          }
        ]
      }
    ]
  }
}

Filter By Contact Name and Type (AND Example)

{
  "module": "contact",
  "filters": {
    "filter": [
      {
        "$and": [
          {
            "firstname": {
              "$equals": "Dakota QA 2"
            }
          },
          {
            "firstname": {
              "$equals": "Endowment"
            }
          }
        ]
      }
    ]
  }
}

Filter By Last Modified Date Range

{
  "module": "contact",
  "filters": {
    "order_by": "firstname:DESC",
    "max_num": 50,
    "offset": 0,
    "filter": [
      {
        "lastmodifieddate": {
          "$between": ["2025-01-01", "2025-01-20"]
        }
      }
    ],
    "fields": ["sfid", "firstname", "lastmodifieddate", "contact_type__c"]
  }
}

Authorizations

Oauth-Token
string
header
required

Get the OAuth token by calling the /oauth2 authentication API. Use the access_token from the response to authorize your API requests.

Body

text/plain

Copy any of the JSON examples and paste it into the request body field.