The Noticeable API implements GraphQL, a flexible and powerful alternative to REST. It allows defining precisely the data to fetch and alter, all in a single call when needed.

Authenticating with GraphQL

To communicate with the GraphQL server, you'll need an Access Token. Only project owners are allowed to manage tokens. If you are a collaborator, contact your project owner to get a token.

The GraphQL endpoint

The Noticeable GraphQL API has a single endpoint:
https://api.noticeable.io/graphql

The endpoint remains constant no matter what operation you perform (query or mutation).

Sending requests

The GraphQL API accepts both GET and POST requests.

You can make HTTP requests with any clients. For testing purposes, we recommend using our custom Playground IDE instance. It provides examples, automatic completion, real-time error highlighting, intelligent type ahead and syntax highlighting:

https://playground.noticeable.io

GET requests

A GET request must pass query, optional variables and operationName in the URL. Here is a well-formatted example using cURL:

curl --header "Authorization: Apikey YOUR_ACCESS_TOKEN" \
--get https://api.noticeable.io/graphql \
--data-urlencode "query=query { organization { projects(first: 5) { pageInfo { hasNextPage } edges { node { name posts(last: 10) { edges { node { title permalink } } } } } } } }"


This query fetches the name of the first 5 projects along with the last 10 publications title and permalink for each project.

POST requests

A POST request accepts a JSON body. It must contain either a query or an operationName (or both, in case of a named query), and may include variables.

Here's an example of a valid POST request using cURL. It fetches the same data as the GET request above:

curl --header "Content-Type: application/json" \
--header "Authorization: Apikey YOUR_ACCESS_TOKEN" \
--request POST https://api.noticeable.io/graphql \
--data '{"query": "query { organization { projects(first: 5) { pageInfo { hasNextPage } edges { node { name posts(last: 10) { edges { node { title permalink } } } } } } } }"}'


Mutations must be performed with a POST request.
Was this article helpful?
Cancel
Thank you!