Get a search index

GET

https://api.contentful.com/organizations/:organization_id/semantic/search-index/:index_id

GET

/organizations/:organization_id/semantic/search-index/:index_id

$ curl https://api.contentful.com/organizations/0D9ZC8rLWiw6x5qizZGiRs/semantic/search-index/3a2b1c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d \
>      -H "Authorization: Bearer <token>"

200Content semantics_getASearchIndex_example

1 {
2   "sys": {
3     "id": "abc123",
4     "type": "ContentSemanticsIndex",
5     "organization": {
6       "sys": {
7         "type": "Link",
8         "linkType": "Organization",
9         "id": "myOrg"
10       }
11     },
12     "space": {
13       "sys": {
14         "type": "Link",
15         "linkType": "Space",
16         "id": "mySpace"
17       }
18     },
19     "environment": {
20       "sys": {
21         "type": "Link",
22         "linkType": "Environment",
23         "id": "master"
24       }
25     },
26     "locale": {
27       "sys": {
28         "type": "Link",
29         "linkType": "Locale",
30         "id": "locale123"
31       }
32     },
33     "localeCode": "en-US",
34     "createdBy": {
35       "sys": {
36         "type": "Link",
37         "linkType": "User",
38         "id": "user123"
39       }
40     },
41     "status": "ACTIVE",
42     "createdAt": "2025-08-21T13:41:54.274Z",
43     "updatedAt": "2025-08-21T13:41:54.274Z"
44   }
45 }

Authentication

AuthorizationBearer

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

Path parameters

organization_idstringRequired

ID of the organization

index_idstringRequired

ID of the search index

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful