The MobilizeHub API uses HTTP RPC-style methods and generally follow the schema:

https://api.mobilizehub.com/{version}/{service}.{method}

​
HTTP Methods

The API supports the following HTTP methods:

  • GET: Retrieve data from the API.
  • POST: Send data to the API to create or update a resource.
  • DELETE: Remove a resource using the API.

All methods are idempotent, meaning that making the same request multiple times will have the same effect as making it once.

​
Get

GET methods are used for reading data. Filtering, sorting, or pagination is done via query parameters.

curl "http://api.mobilizehub.com/v1/contact.get-contact?contactId=con_123456789&organizationId=org_123456789" \
-H "Authorization: Bearer <API_KEY>"

​
Post and Delete

POST methods are used for creating and updating deleting data, while DELETE methods are used for removing data. Data is passed as application/json in the request body.

curl -XPOST "http://api.mobilizehub.com/v1/contact.create-contact" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{"email": "ryan@mobilizehub.com", orgId: "org_123456789"}'

​
Authentication

Authentication is performed using HTTP Bearer authentication in the Authorization header:

Authorization: Bearer unkey_1234567890

Example request:

curl -X POST "https://api.mobilizehub.com/v1/contact.create-contact" \
  -H "Authorization: Bearer key_1234567890" \
  -H "Content-Type: application/json" \
  -d '{ "organizationId": "org_1234", "email": "ryan@mobilizehub.com" }'

If your authentication fails, you’ll receive a 401 Unauthorized or 403 Forbidden response with an error message:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "The provided api key is invalid or has been revoked",
    "docs": "http://docs.mobilizehub.com",
  }
}

​
Rate limit

The default maximum rate limit is 10 requests per second. After that, you’ll hit the rate limit and receive a 429 response error code with an error message:

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "You have exceeded the maximum number of requests per second",
    "docs": "http://docs.mobilizehub.com",
  }
}