Skip to main content
GET
/
1
/
sources
/
{sourceID}
curl
curl --request GET \
  --url https://data.us.algolia.com/1/sources/6c02aeb1-775e-418e-870b-1faccd4b2c0f \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "type": "bigcommerce",
  "name": "<string>",
  "owner": "<string>",
  "input": {
    "storeKeys": [
      "<string>"
    ],
    "locales": [
      "fr-FR"
    ],
    "url": "<string>",
    "projectKey": "<string>",
    "fallbackIsInStockValue": true,
    "productQueryPredicate": "<string>",
    "customFields": {
      "inventory": [
        "<string>"
      ],
      "price": [
        "<string>"
      ],
      "category": [
        "<string>"
      ]
    }
  },
  "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
Required ACL: addObject, deleteIndex, editSettings

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
sourceID
string
required

Unique identifier of a source.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

Response

OK

​
sourceID
string
required

Universally uniqud identifier (UUID) of a source.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

​
type
enum<string>
required
Available options:
bigcommerce,
bigquery,
commercetools,
csv,
docker,
ga4BigqueryExport,
json,
shopify,
push
​
name
string
required
​
createdAt
string
required

Date of creation in RFC 3339 format.

​
updatedAt
string
required

Date of last update in RFC 3339 format.

​
owner
string | null

Owner of the resource.

​
input
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
​
authenticationID
string

Universally unique identifier (UUID) of an authentication resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

⌘I