Skip to main content
  1. API Endpoints: All operations are performed through specific endpoints. These endpoints are relative to the base URL: https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  2. Authentication: To access the API, you’ll need an API token. If you don’t have one yet, get in touch with us at support@fieldpulse.com to register and activate your API token. You will include this token in the header of your requests using the key x-api-key.
  3. HTTP Methods: We use standard HTTP methods in our API.
    • GET to retrieve resources
    • POST to create resources
    • PUT to update resources
    • DELETE to delete resources
  4. Response Format: All responses are returned in JSON format.
  5. Status Codes: The API uses standard HTTP status codes to indicate success or failure of API requests.
    • 200 OK: Everything worked as expected
    • 201 Created: Everything worked as expected
    • 202 Accepted: Authentication is passed
    • 400 Bad Request: The request was unacceptable, often due to missing a required parameter or wrong parameter.
    • 401 Unauthorized: for missing/invalid authentication
    • 404 Not Found: for non-existing resources
    • 422 Unprocessable Entity: authentication validation error
    • 429 Quota exceeded: You have reached your monthly request quota.
    • 429 Throttled: You have reached your per second rate limit.
    • 500 Internal Server Error: for server errors
  6. Rate Limits - The FieldPulse API has rate limits, wich is 50 requests per second , to manage the volume of calls to our API. Once the rate limit is exceeded, subsequent requests will receive an error response with a status 429. 429 responses will include a header (RateLimit-Reset) with the time (in epoch format) that the user rate limit will be reset. If you are exceeding the rate limit regularly, email us to discuss alternative options.
  7. Request Data Validation - all POST and PUT requests have data validation rules , which are in the requests body descriptions. Please make a note, . optional - means the data is not required . nullable - means the value can be null