Articles on: How To Guides

How to use the Noticeable API?

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.

Authenticating with GraphQL

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

The GraphQL endpoint

The Noticeable GraphQL API has a single endpoint:

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:

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 \
     --data '{"query": "query { organization { projects(first: 5) { pageInfo { hasNextPage } edges { node { name publications(last: 10) { edges { node { title permalink } } } } } } } }"}'

Mutations must be performed with a POST request.

Updated on: 12/16/2022

Was this article helpful?

Share your feedback


Thank you!