Get Configurations

get

https://preview.threekit.com/api/configurations

Retrieves a list of all configurations associated with an organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

orgId

string

Organization ID.

productId

string

Product ID.

productVersion

string

Product version.

shortId

string

Short ID.

sku

string

SKU of the configuration.

metadata

string

Arbitrary metadata to be used to fetch list of configurations. Since it is a query string parameter, it needs to be correctly stringified and encoded. Example 'metadata=%7B%22ExampleKey%22%3A%22ExampleValue%22%7D'

fullConfiguration

boolean

Fetches detailed information about the configuration, specifically item name and item metadata for part references. **NOTE - The current implementation assumes that the format of the variant field is identical to how the player stores configuration. For a custom format, there is a possibility that it may not work

page

number

Page to return, defaults to 1

perPage

number

Total number of entries per page, defaults to 30 and can only go up to 100

sort

string

The direction and value to sort by, defaults to createdAt descending (denoted -createdAt)

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful GET request. Response body will include list of configurations.

401User is not authenticated. They must be authenticated to use this service.

403User is authenticated but lacks authorization to use this service

404No configurations exist in the database, based on the query parameter(s) provided.