Get a Preview API key

GET

https://api.contentful.com/spaces/:space_id/preview_api_keys/:preview_api_key_id

GET

/spaces/:space_id/preview_api_keys/:preview_api_key_id

$ curl https://api.contentful.com/spaces/yadj1kx9rmg0/preview_api_keys/preview_api_key_id \
>      -H "Authorization: Bearer <token>"

200API keys_getAPreviewApiKey_example

1 {
2   "sys": {
3     "type": "PreviewApiKey",
4     "id": "exampleapikey",
5     "version": 1,
6     "space": {
7       "sys": {
8         "type": "Link",
9         "linkType": "Space",
10         "id": "yadj1kx9rmg0"
11       }
12     },
13     "createdAt": "2026-01-06T07:58:55.000Z",
14     "createdBy": {
15       "sys": {
16         "type": "Link",
17         "linkType": "User",
18         "id": "7BslKh9TdKGOK41VmLDjFZ"
19       }
20     },
21     "updatedAt": "2026-01-06T07:58:55.000Z",
22     "updatedBy": {
23       "sys": {
24         "type": "Link",
25         "linkType": "User",
26         "id": "4FLrUHftHW3v2BLi9fzfjU"
27       }
28     }
29   },
30   "name": "Example API Key",
31   "description": null,
32   "accessToken": "e5e8d4c5c122cf28fc1af3ff77d28bef78a3952957f15067bbc29f2f0dde0b50",
33   "environments": [
34     {
35       "sys": {
36         "type": "Link",
37         "linkType": "Environment",
38         "id": "staging"
39       }
40     }
41   ]
42 }

This endpoint returns details about an existing Preview API key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in a form of a string

preview_api_key_idstringRequired

preview_api_key_id identifier

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful