📤 API Requests

All requests to api.implan.com must:

• Use HTTPS
• Must include a valid JWT
  • see Authentication for information on retrieving that token
  • This is included in the header as Authentication = Bearer {token}
• If a json body is included with the request, the Content-Type header must be application/json.
• All request routes are case-sensitive.
• All text is expected to be encoded with utf-8.

---

Parameters

Any Request parameters will be specified under the endpoint in a table:

Parameter	Spec	Type	Details
{name}	{spec}	{type}	{details}

• name
  • The name of the parameter.
  • Whether camelCase or PascalCase, the parameter is expected to be declared exactly.
• spec
  • Where this parameter is specified:
    • route - The Parameter is part of the route, such as /api/v1/regions/{aggScheme}.
    • query - The Parameter is a Query Parameter and is specified that way, such as /api/v1/regions?urid=123123123`.
    • header - The Parameter is passed as part of the Request Headers.
    • body - The data should be turned into json and passed in the body.
    • form - The data should be passed in as Form Data with a Content-Type of application/x-www-form-urlencoded or multipart/form-data.
• type
  • The type of data that belongs to this Parameter:
    • int: An integer value, usually positive. No decimal places are allowed.
      • e.g.: 114740, 23495874, -123
    • float: A floating-point value, used for monetary and fractional amounts. Decimal places are allowed.
      • e.g.: 1000.00, 9243.2446, -13.203458534
    • str: A [string](https://en.wikipedia.org/wiki/String_(computer_science) of textual data. These must be utf-8 encoded and surrounded by quotation marks.
      • e.g.: "North Carolina", "Example Project #24"
    • json: This is also a string, but specifically must be properly encoded json.
    • guid: A guid | uuid in string form. Must be surrounded by quotation marks.
      • e.g.: "b91b0025-7bb1-4046-a968-4c73190f23ea", "B980255B-6FA1-48DE-9172-11214EB9FEA7"
    • bool: A boolean value of true or false
    • null: Indicates the absence of a value
      • null is not zero!
        
    • date: The data is a date and/or time value encoded as a str.
      • e.g. "2025-08-12" or "2025-08-12T14:19:51"
    • array: The data is an array or list of other values.
      • These might be simple values, like an array of ints: [1, 4, 7, 13]
      • Or they might be more complex structures that have their own definitions.
  • If a value is optional (not required to be specified), the type will also be annotated with a question mark (❔).
    • These values have defaults specified internally.
    • To specify that the default should be used, pass null.
    • e.g.: A Parameter marked as int❔ could have a value of 147, 0, or null.
• details
  • Additional details about the value, such as links to other Wiki documents or examples.