What's in an API call?

A few foundational principles to help you land on your feet

In addition to the HTTP method of your request and the HTTP response code, there are several other ways to include data with your API call.

📘

Parameters, aka Params

Don't get confused if you see "Params" in place of "Parameters" throughout our UI and documentation

Headers

Headers are a way to pass in additional details along with your API call. Headers usually include metadata like timestamps or security details like Bearer Tokens or Signing Signatures

Path Parameters

  • Some endpoints have variables in the URL, meaning you should replace the variable with an actual value. These are represented in an endpoint with {curlyBrackets} such as:
Sample path parameters, make sure to put your teamsite ID & library content IDs in there!Sample path parameters, make sure to put your teamsite ID & library content IDs in there!

Sample path parameters, make sure to put your teamsite ID & library content IDs in there!

Query Parameters

  • Some endpoints are able to take extra values at the end of the URL after a "?". If there are multiple query params, they are separated by an "&"
    For example the Contents endpoint can have values like this at the end, asking for a maximum of 100 characters and for documents modified after May 1st, 2022:
Sample query parameters, the first is limiting the response to 100 records, and the second is filtering only contents that were modified after May 1stSample query parameters, the first is limiting the response to 100 records, and the second is filtering only contents that were modified after May 1st

Sample query parameters, the first is limiting the response to 100 records, and the second is filtering only contents that were modified after May 1st

Body Parameters

(aka Body Params}
As API requests get too complex or lengthy, you will need to add information to the main body of your request, sometimes called the Payload. In most cases the body parameters are just text inputs that we consume in a JSON format but there are more complex examples where the payload can have multiple parts, like file attachments

{
    "sort":[
        {
            "field":"modifiedDate",
            "order":"asc"
        }
    ],

    "filter": {
        "operator": "and",
        "conditions":[
            {
                "attribute": "repository",
                "operator": "equal",
                "value": "library"
            },
            
            {
                "attribute": "name",
                "operator": "equal",
                "value": "randin"
            }
        ]
    }
}

Did this page help you?