Getting started with REST API

Learn how to make calls to the REST API.

Follow these steps to make a simple call to the REST API using curl in the command line.

1. Log in to Snyk.

2. Navigate to the Org Settings (gear icon) for an organization where you have projects you can list.

3. Find the Organization ID and copy the value.

4. Navigate to your General Account Settings and copy your API Token. For instructions, see See How to obtain and authenticate with your API token.

5. Copy the version string from the URL, for example, 2022-06-08~beta and paste the version string into the QUERY-STRING PARAMETERS version field (also required).

6. Use the curl command to make your request. Replace the {orgId} and API_TOKEN with your Organization ID and API Token, respectively. For the version parameter, it is advised to use the current day's date.

curl --request GET \
--url "https://api.snyk.com/rest/orgs/{orgId}/projects?version=2024-06-10" \
--header "Content-Type: application/vnd.api+json" \
--header "Authorization: token API_TOKEN"

Note that if you use the parameter target-reference, you must URL-encode it. If you have any problems or questions, contact Snyk support.