Since Pitchly uses GraphQL for its API, every request is routed to a single URL endpoint.
Since REST is backwards compatible with GraphQL, if you would rather use REST, you can do so by:
Sending all requests to the same URL above
Using the POST method for all requests
Setting the Content-Type header of the request to
Putting the REST-equivalent JSON from each example in the Body of the request
Each example provided in this documentation reference will show both a GraphQL version of the request and an equivalent REST version. The result that follows the request will be the same for each.
It is common practice to put authorization tokens in the header of API requests, but we include tokens in the body of our requests for convenience and better event tracking.
In the following examples, we are going to use an App Secret (shown as
secretKey) to authorize each request. This makes sense when using our API to interact with your own account programmatically. If you are alternatively accessing data on behalf of another user or account using our App SDK, you would swap out the
secretKey for an
If you don't already have an App Secret, contact us and we'll get you squared away.
At a high level, there are three types of requests you can make with Pitchly's API: