List sources

Retrieves a list of sources.

GET /1/sources

curl

cURL

curl --request GET \
  --url 'https://data.us.algolia.com/1/sources?itemsPerPage=10&page=1&type=commercetools%2Cbigcommerce&authenticationID=10000000-0a75-4000-a000-000000000001%2Cnone&sort=createdAt&order=desc' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "sources": [
    {
      "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "type": "bigcommerce",
      "name": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "owner": "<string>",
      "input": {
        "url": "<string>",
        "projectKey": "<string>",
        "storeKeys": [
          "<string>"
        ],
        "locales": [
          "fr-FR"
        ],
        "fallbackIsInStockValue": true,
        "productQueryPredicate": "<string>",
        "useImagesObjects": true,
        "customFields": {
          "inventory": [
            "<string>"
          ],
          "price": [
            "<string>"
          ],
          "category": [
            "<string>"
          ]
        }
      },
      "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
    }
  ],
  "pagination": {
    "nbPages": 2,
    "page": 2,
    "nbItems": 1,
    "itemsPerPage": 10
  }
}

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.

Query Parameters

itemsPerPage · integer · default: 10

Number of items per page.

Required range: 1 <= x <= 100

page · integer

Page number of the paginated API response. Page of the API response to retrieve.

Required range: x >= 1

type · enum<string>[]

Source type. Some sources require authentication.

Available options: bigcommerce, bigquery, commercetools, csv, docker, ga4BigqueryExport, json, shopify, push

Example:

"commercetools,bigcommerce"

authenticationID · string[]

Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication.

Universally unique identifier (UUID) of an authentication resource.

Example:

[
  "10000000-0a75-4000-a000-000000000001",
  "none"
]

sort · enum<string> · default: createdAt

Property by which to sort the list of sources.

Available options: name, type, updatedAt, createdAt

order · enum<string> · default: desc

Sort order of the response, ascending or descending. Ascending or descending sort order.

Available options: asc, desc

Response

200

application/json

OK

sources · object[] · required

Show child attributes

sources. sourceID · string · required

Universally uniqud identifier (UUID) of a source.

Example:

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

sources. type · enum<string> · required

Available options: bigcommerce, bigquery, commercetools, csv, docker, ga4BigqueryExport, json, shopify, push

sources. name · string · required

sources. createdAt · string · required

Date of creation in RFC 3339 format.

sources. updatedAt · string · required

Date of last update in RFC 3339 format.

sources. owner · string | null

Owner of the resource.

sources. input · object

Specific configuration attributes of a commercetools source.

Option 1

Show child attributes

sources.input. url · string · required

sources.input. projectKey · string · required

sources.input. storeKeys · string[]

Unique and immutable key of the referenced store.

sources.input. locales · string[]

Locales for your commercetools stores.

Locale specified as combination of a two-letter language code and an optional two-letter country code.

sources.input. fallbackIsInStockValue · boolean · default: true

Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.

sources.input. productQueryPredicate · string

Predicate to filter out specific products when indexing. For more information, see Query Predicate.

sources.input. useImagesObjects · boolean

When set to true, the connector indexes objects with all images attributes instead of only the URLs.

sources.input. customFields · object

Custom fields from commercetools to add to the records.

For more information, see Using Custom Types and Custom Fields.

Show child attributes

sources.input.customFields. inventory · string[] | null

Inventory custom fields.

sources.input.customFields. price · string[] | null

Price custom fields.

sources.input.customFields. category · string[] | null

Category custom fields.

sources. authenticationID · string

Universally unique identifier (UUID) of an authentication resource.

Example:

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

pagination · object · required

Paginated API response.

Show child attributes

pagination. nbPages · integer · required

Number of pages in the API response.

Required range: x >= 1

pagination. page · integer · required

Page of the API response to retrieve.

Required range: x >= 1

pagination. nbItems · integer · required

Number of items in the API response.

Required range: x >= 0

pagination. itemsPerPage · integer · default: 10 · required

Number of items per page.

Required range: 1 <= x <= 100