API Documentation

Introduction

Welcome to the Pro-filr API You can use our API to access Pro-filr API endpoints, which can get information on various services and opportunities in our database. We have language bindings in PHP and JavaScript. This API documentation page was created for developers use. Feel free to edit it and use it as a base for your own API's documentation.

API Basics

The Pro-filr API gives you access to pretty much all the features you can use on our dashboard and lets you extend them for use in your application. It strives to be RESTful and is organized around the main resources you would be interacting with - with a few notable exceptions. Before you do anything, you should create a free Pro-filr account that you can test the API against. We will provide you with test keys that you can use to make API calls.

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is drop in your specific parameters, and you can test the calls from the command line. See tutorial on using cURL with APIs. Of course you can use POSTMAN as well if cURL isn't your cup of tea. POSTMAN is an easy to use API development environment for making HTTP requests.

Input/Output Format

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Standard API response format
{
"status": [boolean] - Only true if the details provided could be processed and no error occured while processing,
"message": [string] - Explains why status is false... Entirely informational. Please only log this but do not use for your checks,
"data": [object] - contains actionable result of processing if present
}

While we generally recommend that developers use HTTP status codes to determine the result of an API call, we have provided a handy status key to let you know upfront if the request was successful or not.

The message key is a string which will contain a summary of the response and its status. For instance when trying to retrieve services search of professionals, message might read “Search professionals complete”. In the event of an error, the message key will contain a description of the error as with the authorization header situation above. This is the only key that is universal across requests.

The data key is where you want to look at for the result of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a search services process, this will return an object in the data key, while the key would be an array of results if a list is requested instead.

Get Started