Propeller CRM Developer Hub

The propeller-test Developer Hub

Welcome to the propeller-test developer hub. You'll find comprehensive guides and documentation to help you start working with propeller-test as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started

Authorization

Your must provide an Authorization header in every request that includes both your user id and a valid API key. You can generate an API key here: https://app.propellercrm.com/settings/api/

The key itself is a long string that looks something like this:

fcb6f252fa0ecff5a6989741c2ead8bebcccef35974c308ab1791f6979b49696

You combined this key with the email address of the user who generated this key to create the authorization header:

Authorization: ApiKey [email protected]:apikey

Your First Request

Here's a sample call to get a list of your contacts

curl 'https://app.propellercrm.com/api/v1.0/contacts/' \
  -H 'Authorization: ApiKey [email protected]:apikey'

Specifying Attributes

Your requests will run faster if you only ask for the attributes you need. You can do this by supplying a fields parameter with a comma separated list of attributes. For example, let's modify our last request for contacts to get only the first and last names.

curl 'https://app.propellercrm.com/api/v1.0/contacts/?fields=firstName,lastName' \
  -H 'Authorization: ApiKey [email protected]:apikey'

If you are making a listing of contacts and you want to display the names of the associated accounts, you can use the '__' operator in your field parameters to specify that you want to drill down into the hierarchy of objects. Make sure some of your contacts have accounts before you try this one:

curl 'https://app.propellercrm.com/api/v1.0/contacts/?fields=firstName,lastName,account__name' \
  -H 'Authorization: ApiKey [email protected]:apikey'

You can choose to get all of the attributes when using the fields parameter by using a *

curl 'https://app.propellercrm.com/api/v1.0/contacts/?fields=*,account__name'
  -H 'Authorization: ApiKey [email protected]:apikey'

Sorting

You can use the order_by parameter to specify which attribute to sort by. Let's sort your contacts by first name.

curl 'https://app.propellercrm.com/api/v1.0/contacts/?fields=firstName,lastName&order_by=firstName' \
  -H 'Authorization: ApiKey [email protected]:apikey'

Pagination

By now you may have noticed that these requests are only returning the first 20 results by default. In order to get the rest, we can use the limit and offset parameters. Here's how to get results 21-40 (obviously you'll need more than 20 contacts in the system for this to work):

curl 'https://app.propellercrm.com/api/v1.0/contacts/?fields=firstName,lastName&offset=20&limit=20' \
  -H 'Authorization: ApiKey [email protected]:apikey'

Filtering

To limit what's returned, you can filter on attributes. The most basic way is to specify a query parameter:

attributeName__operator=value

For example, here's how to return only contacts who have the first name 'Jeff':

curl 'https://app.propellercrm.com/api/v1.0/contacts/?firstName__exact=Jeff' \
  -H 'Authorization: ApiKey [email protected]:apikey'

Here are the operators you can use on the various types.

Text

Operator
Description
Example

exact

Exact match (currently case sensitive)

firstName__exact=Jeff

notequal

Not equal

firstName__notequal=Joe

startswith

Starts with

firstName__startswith=Jeff

notstartswith

Does not start with

firstName__notstartswith=Q

contains

Contains

firstName__contains=ef

notcontains

Does not contain

firstName__notcontains=oe

Date, DateTime

Operator
Description
Example

lt

Before

closeDate__lt=2017-01-25

gt

After

closeDate__gt=2017-01-25

range

In between

closeDate__range=2017-01-01,2018-01-01

Number, Percentage, and Money

Operator
Description
Example

exact

Exactly

amount__exact=5000

lt

Less than

amount__lt=5000

lte

Less than or equal to

amount__lte=5000

gt

Greater than

amount__gt=3000

gte

Greater than or equal to

amount__gte=3000

range

Between

amount__range=3000,5000

Getting Started