The Journey by Forj API is based on RESTful principles; we also use HTTP authentication standards and HTTP methods to make the Journey by Forj API as easy to use as possible.

We welcome your feedback with regards to issues and improvements. Please contact your customer success manager at support@forj.ai with any questions or comments.

📘
Note: This documentation references Mobilize because the API originated from the Mobilize platform, now part of Forj and Journey by Forj. The functionality, support, and roadmap for these APIs are managed within the Forj platform.

Versioning

The current API version is V1.
The version number will change any time there is a change that is not backward compatible.
You can access to the current version at https://api.mobilize.io/v1/

Requesting Access

Your community admin user may generate an API keys by going to
community settings > Integrations > generate API keys.

🚧
API Secret
Please Keep the secret key in a safe place. We will not show the secret key again after the initial display.

For now we support only one integration key per community. if you wish to have more than one API key please contact your customer success manager at support@forj.ai to ask for additional API keys.

Privacy and privilege

The Network admin has the highest privileges to their community.
All of your API requests will have the same privileges as the community admin.

Note: Temporary keys to test the API before launching a production version are not provided at this time.
Please test your code carefully before launching to an existing community.

Security and Authentication

API requests are authenticated using standard HTTP Basic authentication.
You must use the key to authenticate on each API call.
Basic Authentication:
user name : [ API KEY ]
password : [ API SECRET ]

REQUEST
curl -X GET https://api.mobilize.io/v1/groups
  -u [API KEY]:[API SECRET]

HTTP Operations

We are a RESTful API with an endpoint of https://api.mobilize.io. All responses will be returned in JSON format.

GET: retrieve an object or set of objects.
POST: add a new object.
PUT: update an existing object.
DELETE: remove an object.

📘
Not all API end points support all operations at this time.

Error Codes

The API supports HTTP response standard error code.
200 is for successful request. 4xx are for error requests and 5xx are for unexpected server errors.
HTTP Status Codes:
200 Ok - normal successful request
400 Bad Request - normally a missing or malformatted parameter
401 Unauthorized - missing credentials
403 Forbidden - provided key does not have access for that method
404 Not Found - requested object does not exist
422 Unprocessable Entity - often the posted object is malformatted
500 Server Error - an unexpected error on the parameters
503 Service Unavailable - likely a deploy is occurring or migration.

Name	Type	Definition
status_code	Numeric	http status code.
error_message	Text	error message to help the developer to understand the problem.

REQUEST
curl -X GET https://api.mobilize.io/v1/group/{id}
  -u [API Key]:[API Secret]

RESPONSE
HTTP/1.1 404 NOT FOUND
{
  "status_code": 404,
  "error_message": "Group {id} not found"
}