Skip to main content
GET
/
1
/
sources
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'
{
  "sources": [
    {
      "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>"
    }
  ],
  "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.

Required range: x >= 1
​
type
enum<string>[]

Source type. Some sources require authentication.

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.

Available options:
asc,
desc

Response

OK

​
sources
object[]
required
​
pagination
object
required

Paginated API response.

⌘I